Download OpenAPI specification:
OpsChain is an orchestration and change automation platform based in GitOps principles with a core objective to Unify Change. Connect, automate, and orchestrate people, processes, and tools across your on-premise and cloud platforms.
Endpoints to interact with projects.
Notes:
show and list response payloads include links to the project's assets, changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the assets, changes, scheduled activity, bookmarks and MintModels endpoints respectively./<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.Lists all projects (including archived projects).
Each project in the response includes a link to:
changes endpoint for managing changes belonging to this project. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this project. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this project. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this project. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this project's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this project's workflows. It acts like a Workflows endpoint.
.| filter[<query/sort filter>]= | |
| download | string Example: download=projects.csv Download the projects in CSV format with the specified file name. The projects will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "b6617e0c-1c2a-4294-8c93-8f3a649be41d",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "sharita",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "74335764-fd3c-4fda-86f2-f0c1bf23fbdd",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/74335764-fd3c-4fda-86f2-f0c1bf23fbdd"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "742416c2-ba74-40b7-bf6a-f8338ad54be1",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/742416c2-ba74-40b7-bf6a-f8338ad54be1"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Creates a project.
required | object |
{- "data": {
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "project_type": "Enterprise"
}
}
}{- "data": {
- "id": "960acc37-2ac3-4eda-ad48-21cdfafa4855",
- "type": "project",
- "attributes": {
- "code": "hi6p4",
- "name": "eos518",
- "description": "Quidem eum est aut.",
- "archived": false,
- "created_by": "dionna.lind",
- "project_type": "Standard"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "83d9746d-6acd-4c8a-9dbf-c8f68b54350b",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/83d9746d-6acd-4c8a-9dbf-c8f68b54350b"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "fbd4fb8b-7322-4e82-a737-88c9bffefd39",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/fbd4fb8b-7322-4e82-a737-88c9bffefd39"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/hi6p4",
- "bookmarks": "/api/projects/hi6p4/bookmarks",
- "git_remotes": "/api/projects/hi6p4/git_remotes",
- "environments": "/api/projects/hi6p4/environments"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "environment"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false
}, - "environments": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
}Shows a project, including any direct children.
The response includes a link to:
changes endpoint for managing changes belonging to this project. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this project. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this project. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this project. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this project's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this project's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
{- "data": {
- "id": "551599de-3753-4837-a97e-85f235531652",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "millard",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "48d6a6cf-625e-410e-ab8c-0a31cd722fdf",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/48d6a6cf-625e-410e-ab8c-0a31cd722fdf"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "32983ccc-8df2-47c6-a8de-085e6aa4000b",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/32983ccc-8df2-47c6-a8de-085e6aa4000b"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - "included": [ ]
}Updates a project.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "name": "Modified",
- "description": "The updated project",
- "archived": false
}
}
}{- "data": {
- "id": "f2d5e9bd-6fcb-4734-89bc-3a68de82b656",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "similique527",
- "description": "Voluptas nesciunt aut aut.",
- "archived": true,
- "created_by": "basilia_grimes",
- "project_type": "Standard"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "f4a2ea85-0a69-441d-942d-d3fb28300a12",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/f4a2ea85-0a69-441d-942d-d3fb28300a12"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "1fc87889-5434-48c7-95ee-573ad3c8572f",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/1fc87889-5434-48c7-95ee-573ad3c8572f"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "git_remotes": "/api/projects/opc/git_remotes",
- "environments": "/api/projects/opc/environments"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "environment"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false
}, - "environments": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
}Endpoints to interact with environments.
Notes:
show and list response payloads include links to the environment's assets, changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the assets, changes, scheduled activity, bookmarks and MintModels endpoints respectively./<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.Lists all project environments (including archived environments).
Each environment in the response includes a link to:
changes endpoint for managing changes belonging to this environment. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this environment. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this environment. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this environment. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this environment's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this environment's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | |
| download | string Example: download=environments.csv Download the project environments in CSV format with the specified file name. The environments will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "6138933a-c077-4b9d-9292-944ecdf66d6b",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "vanesa.spinka"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "6a10e6e5-0a41-4488-bc51-82e82dfecd73",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/6a10e6e5-0a41-4488-bc51-82e82dfecd73"
}
}, - "parents": {
- "data": [
- {
- "id": "1a1518cd-3c85-4a24-9eea-7c62ab82ca6f",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "c4d63dbf-69fc-4f0c-9f19-dc7900e83d39",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/c4d63dbf-69fc-4f0c-9f19-dc7900e83d39"
}
}, - "project": {
- "data": {
- "id": "1a1518cd-3c85-4a24-9eea-7c62ab82ca6f",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "assets": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Creates an environment.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment"
}
}
}{- "data": {
- "id": "11953cdb-44a8-4ca5-8db0-04667d198f0b",
- "type": "environment",
- "attributes": {
- "code": "z8noj",
- "name": "consequatur476",
- "description": "Voluptatem rerum reiciendis quasi.",
- "archived": false,
- "created_by": "haywood"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "aaffea63-416c-47bd-ad26-604f8a601da2",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/aaffea63-416c-47bd-ad26-604f8a601da2"
}
}, - "parents": {
- "data": [
- {
- "id": "2b94f1be-21e0-4322-b88d-77fe50a948f8",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "8cc24175-5e54-4aa5-bc86-5f185403dc6b",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/8cc24175-5e54-4aa5-bc86-5f185403dc6b"
}
}, - "project": {
- "data": {
- "id": "2b94f1be-21e0-4322-b88d-77fe50a948f8",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/z8noj",
- "bookmarks": "/api/projects/opc/environments/z8noj/bookmarks",
- "changes": "/api/projects/opc/environments/z8noj/changes",
- "scheduled_activities": "/api/projects/opc/environments/z8noj/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/z8noj/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "assets": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
}Shows an environment.
The response includes a link to:
changes endpoint for managing changes belonging to this environment. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this environment. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this environment. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this environment. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this environment's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this environment's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
{- "data": {
- "id": "e1abbddd-a43e-4e41-912e-3fcdc70ea8fb",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "tamisha"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "6f98a1f0-238d-4a5a-8d4e-97664ee3f756",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/6f98a1f0-238d-4a5a-8d4e-97664ee3f756"
}
}, - "parents": {
- "data": [
- {
- "id": "bd9a8ea5-7d57-4d03-8afa-ad7e7059a7da",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "f323953f-28d1-4785-9254-46b28a0a647b",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/f323953f-28d1-4785-9254-46b28a0a647b"
}
}, - "project": {
- "data": {
- "id": "bd9a8ea5-7d57-4d03-8afa-ad7e7059a7da",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "assets": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - "included": [
- {
- "id": "bd9a8ea5-7d57-4d03-8afa-ad7e7059a7da",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "crista.kunde",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "8961bf4e-19ef-4fa9-8839-cd742b4c0b68",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/8961bf4e-19ef-4fa9-8839-cd742b4c0b68"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "530e0cd9-5681-4835-a661-59cc097acc6a",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/530e0cd9-5681-4835-a661-59cc097acc6a"
}
}, - "children": {
- "data": [
- {
- "id": "e1abbddd-a43e-4e41-912e-3fcdc70ea8fb",
- "type": "environment"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
]
}Updates an environment.
| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
required | object |
{- "data": {
- "attributes": {
- "name": "Modified",
- "description": "The updated environment",
- "archived": false
}
}
}{- "data": {
- "id": "4afdc82b-3678-4ee3-953d-476d3c32d89b",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "facere486",
- "description": "Accusantium reiciendis assumenda nulla.",
- "archived": true,
- "created_by": "gaylene.collier"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "9bffdcd5-87b6-472f-8afe-60c93c929a7c",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/9bffdcd5-87b6-472f-8afe-60c93c929a7c"
}
}, - "parents": {
- "data": [
- {
- "id": "4ac24bea-3166-476d-9158-0336a4ca8bb1",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "6e38ae52-e064-4f0e-beef-579a2d189553",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/6e38ae52-e064-4f0e-beef-579a2d189553"
}
}, - "project": {
- "data": {
- "id": "4ac24bea-3166-476d-9158-0336a4ca8bb1",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "assets": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
}Archives an environment.
| project_code required | string Example: opc project code |
| environment_code required | string Example: dev environment code |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find Node"
}
}
]
}Endpoints to interact with agents.
Notes:
show and list response payloads include links to the agent's assets, changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the assets, changes, scheduled activity, bookmarks and MintModels endpoints respectively./<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.Builds the container image for an agent. Note, this does not restart the agent.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": {
- "id": "3cce9b46-dc38-4033-90c3-fae3b312715d",
- "type": "node_background_task",
- "attributes": {
- "request_number": 2,
- "status_code": "initializing",
- "error_message": null,
- "created_by": "darryl.gerlach",
- "task_type": "BuildAgentImageTask",
- "created_at": "2026-02-23T07:57:38.847974Z",
- "updated_at": "2026-02-23T07:57:38.847974Z",
- "image_sha": null,
- "image_purged": false
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "82b28fe9-3c1b-4e5d-bef1-7ea06f4d2755",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "442240aa-59d8-44fa-920d-d36640018157",
- "type": "agent"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/86d3af3c-3ff7-42c5-a182-fab6c54a0af6/versions/2026_Q1_2",
- "self": "/api/projects/opc/agents/agent1/node_background_tasks/3cce9b46-dc38-4033-90c3-fae3b312715d",
- "agent": "/api/projects/opc/agents/agent1",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=3cce9b46-dc38-4033-90c3-fae3b312715d"
}
}
}Shows the status for an agent.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": {
- "id": "9ebbe1f4-6fb0-4001-ab4f-17a61106c521",
- "type": "agent_status",
- "attributes": {
- "desired_status": "absent",
- "status": "absent",
- "image_build_status": "absent",
- "active_image_sha": null,
- "newest_image_sha": null
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/status",
- "log_lines": "/api/projects/opc/agents/agent1/status/log_lines"
}
}
}Update an agent status.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
required | object |
{- "data": {
- "attributes": {
- "desired_status": "running"
}
}
}{- "data": {
- "id": "4663bb78-34d3-4ce3-a6e1-70098bcdd106",
- "type": "agent_status",
- "attributes": {
- "desired_status": "running",
- "status": "initializing",
- "image_build_status": "absent",
- "active_image_sha": null,
- "newest_image_sha": null
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/status",
- "log_lines": "/api/projects/opc/agents/agent1/status/log_lines"
}
}
}Shows log lines for the agent.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": [
- {
- "id": "0ef42693-3b2e-47e0-986e-7840c6060648",
- "type": "agent_log_line",
- "attributes": {
- "message": "Agents running on OpsChain :-)",
- "category": "action",
- "agent_path": "/projects/opc/agents/agent1",
- "logged_at": "2026-02-22T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Shows Kubernetes events for the agent. This request will only succeed when the agent is running.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": [
- {
- "id": "0",
- "type": "agent_event",
- "attributes": {
- "created_at": "2026-02-13T09:59:50.041123Z",
- "message": "Kubernetes event for this agent."
}
}
]
}Lists all agents (including archived agents) that belong to the project.
Each agent in the response includes a link to:
changes endpoint for managing changes belonging to this agent. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this agent. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this agent. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this agent. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this agent's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this agent's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | |
| download | string Example: download=agents.csv Download the agents in CSV format with the specified file name. The agents will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "c7eea691-a345-413b-8ca8-113116c7ccdd",
- "type": "agent",
- "attributes": {
- "code": "agent1",
- "name": "Agent",
- "description": "Asset description",
- "archived": false,
- "created_by": "max_gusikowski",
- "actions": [ ],
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "bd263996-90eb-47a0-b465-53e81cae6641",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/bd263996-90eb-47a0-b465-53e81cae6641"
}
}, - "parents": {
- "data": [
- {
- "id": "a9f64a51-9e45-43b0-a0d7-7ce255f39f50",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "17a0bf4a-0e30-45eb-aac7-073c62a88a2e",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/17a0bf4a-0e30-45eb-aac7-073c62a88a2e"
}
}, - "project": {
- "data": {
- "id": "a9f64a51-9e45-43b0-a0d7-7ce255f39f50",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "86f34543-ac0e-48e8-b09c-02ad4046871e",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/90f3551e-6e6a-4b30-818f-8c07aee3b771/versions/2026_Q1_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "90f3551e-6e6a-4b30-818f-8c07aee3b771",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/90f3551e-6e6a-4b30-818f-8c07aee3b771"
}
}, - "current_node_background_task": {
- "data": {
- "id": "e792d132-ec64-4fc4-bff6-7a4dcee1a8d3",
- "type": "node_background_task"
}, - "links": {
- "related": "/api/projects/opc/agents/agent1/node_background_tasks/e792d132-ec64-4fc4-bff6-7a4dcee1a8d3"
}
}, - "agent_status": {
- "data": {
- "id": "e0163ee6-e8b3-49d8-ae5d-9d7552618213",
- "type": "agent_status"
}, - "links": {
- "related": "/api/projects/opc/agents/agent1/status"
}
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1",
- "bookmarks": "/api/projects/opc/agents/agent1/bookmarks",
- "converged_properties": "/api/projects/opc/agents/agent1/converged_properties",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/agents/agent1/node_background_tasks",
- "version_history": "/api/projects/opc/agents/agent1/version_history"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Creates an agent.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "agent1",
- "name": "Agent",
- "description": "Asset description",
- "template_name": "Agent example",
- "template_version": "2026_Q1_2"
}
}
}{- "data": {
- "id": "da56e233-212b-4fec-9f67-21720a32a7ec",
- "type": "agent",
- "attributes": {
- "code": "fcj0t",
- "name": "rerum392",
- "description": "Et atque dolores voluptatem.",
- "archived": false,
- "created_by": "mae_bartoletti",
- "actions": [ ],
- "task_active": true
}, - "relationships": {
- "properties": {
- "data": {
- "id": "2e9662f9-268f-4edb-959b-968d795ed71f",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/2e9662f9-268f-4edb-959b-968d795ed71f"
}
}, - "parents": {
- "data": [
- {
- "id": "d31006f5-11ef-4f7d-9dfb-ff70ac2659cc",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "a7f90f7f-1c94-4a23-9c8f-2c23553f8d89",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/a7f90f7f-1c94-4a23-9c8f-2c23553f8d89"
}
}, - "project": {
- "data": {
- "id": "d31006f5-11ef-4f7d-9dfb-ff70ac2659cc",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "66a236b4-a5dd-4f78-8ad8-feae1a2617f1",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/d0b8e297-0963-4edd-9853-b967af5aadd6/versions/2026_Q1_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "d0b8e297-0963-4edd-9853-b967af5aadd6",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/d0b8e297-0963-4edd-9853-b967af5aadd6"
}
}, - "current_node_background_task": {
- "data": {
- "id": "bd6cfe96-c6d2-440b-9f8a-04394a615d17",
- "type": "node_background_task"
}, - "links": {
- "related": "/api/projects/opc/agents/fcj0t/node_background_tasks/bd6cfe96-c6d2-440b-9f8a-04394a615d17"
}
}, - "agent_status": {
- "data": {
- "id": "4121e70a-bc15-4fdb-baf3-99b28e4cd3dc",
- "type": "agent_status"
}, - "links": {
- "related": "/api/projects/opc/agents/fcj0t/status"
}
}
}, - "links": {
- "self": "/api/projects/opc/agents/fcj0t",
- "bookmarks": "/api/projects/opc/agents/fcj0t/bookmarks",
- "converged_properties": "/api/projects/opc/agents/fcj0t/converged_properties",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/agents/fcj0t/node_background_tasks",
- "version_history": "/api/projects/opc/agents/fcj0t/version_history"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
}Shows an agent belonging to a project.
The response includes a link to:
changes endpoint for managing changes belonging to this agent. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this agent. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this agent. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this agent. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this agent's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this agent's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "data": {
- "id": "0a68cbf6-12a0-4d64-bccd-bf35ac45bf6a",
- "type": "agent",
- "attributes": {
- "code": "agent1",
- "name": "Agent",
- "description": "Asset description",
- "archived": false,
- "created_by": "emile_stoltenberg",
- "actions": [ ],
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "ab19fe4b-697e-4825-9198-3370da0e8ba5",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/ab19fe4b-697e-4825-9198-3370da0e8ba5"
}
}, - "parents": {
- "data": [
- {
- "id": "e34ac8fa-cb06-4ba8-94f0-e0c74cf6c20c",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "c02b1f3d-418a-4347-8327-c9b00d21dfbb",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/c02b1f3d-418a-4347-8327-c9b00d21dfbb"
}
}, - "project": {
- "data": {
- "id": "e34ac8fa-cb06-4ba8-94f0-e0c74cf6c20c",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "1a1bb9e5-8dd9-4376-bbfc-6126f914cc01",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/cdec4f16-5beb-4441-a8c9-1fdd77694489/versions/2026_Q1_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "cdec4f16-5beb-4441-a8c9-1fdd77694489",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/cdec4f16-5beb-4441-a8c9-1fdd77694489"
}
}, - "current_node_background_task": {
- "data": {
- "id": "e93449bf-64cc-482b-95cb-e77520f7d687",
- "type": "node_background_task"
}, - "links": {
- "related": "/api/projects/opc/agents/agent1/node_background_tasks/e93449bf-64cc-482b-95cb-e77520f7d687"
}
}, - "agent_status": {
- "data": {
- "id": "18ac5aea-2568-4cc7-b4d6-25f5bbc00a02",
- "type": "agent_status"
}, - "links": {
- "related": "/api/projects/opc/agents/agent1/status"
}
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1",
- "bookmarks": "/api/projects/opc/agents/agent1/bookmarks",
- "converged_properties": "/api/projects/opc/agents/agent1/converged_properties",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/agents/agent1/node_background_tasks",
- "version_history": "/api/projects/opc/agents/agent1/version_history"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - "included": [
- {
- "id": "e34ac8fa-cb06-4ba8-94f0-e0c74cf6c20c",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "galen",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "1b641c2e-5d9c-4e96-84c1-fc2e3248cdc9",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/1b641c2e-5d9c-4e96-84c1-fc2e3248cdc9"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "f70bf118-491c-4a44-b227-4a3309c3759d",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/f70bf118-491c-4a44-b227-4a3309c3759d"
}
}, - "children": {
- "data": [
- {
- "id": "0a68cbf6-12a0-4d64-bccd-bf35ac45bf6a",
- "type": "agent"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - {
- "id": "cdec4f16-5beb-4441-a8c9-1fdd77694489",
- "type": "template",
- "attributes": {
- "code": "agn",
- "name": "Agent example",
- "description": null,
- "archived": false,
- "disabled": false,
- "template_type": "agent",
- "created_at": "2026-02-23T07:58:04.627245Z",
- "updated_at": "2026-02-23T07:58:04.627245Z"
}, - "relationships": {
- "git_remote": {
- "data": {
- "id": "01493fc5-6fdf-4cac-8dc2-bca60136deb9",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [
- {
- "id": "1a1bb9e5-8dd9-4376-bbfc-6126f914cc01",
- "type": "template_version"
}
]
}, - "nodes": {
- "data": [
- {
- "id": "0a68cbf6-12a0-4d64-bccd-bf35ac45bf6a",
- "type": "agent"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/templates/cdec4f16-5beb-4441-a8c9-1fdd77694489",
- "template_versions": "/api/projects/opc/templates/cdec4f16-5beb-4441-a8c9-1fdd77694489/versions",
- "project": "/api/projects/opc"
}
}, - {
- "id": "1a1bb9e5-8dd9-4376-bbfc-6126f914cc01",
- "type": "template_version",
- "attributes": {
- "version": "2026_Q1_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "barney",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "created_at": "2026-02-23T07:58:04.638729Z",
- "updated_at": "2026-02-23T07:58:04.638729Z",
- "git_rev": "redundant",
- "commit_sha": "e094d31bec2264a5501894be715d1edd016ba97c",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "3e105a68-1e41-4158-8639-6969fdd24dd5",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/3e105a68-1e41-4158-8639-6969fdd24dd5"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/cdec4f16-5beb-4441-a8c9-1fdd77694489/versions/2026_Q1_2",
- "template": "/api/projects/opc/templates/cdec4f16-5beb-4441-a8c9-1fdd77694489"
}
}, - {
- "id": "18ac5aea-2568-4cc7-b4d6-25f5bbc00a02",
- "type": "agent_status",
- "attributes": {
- "desired_status": "absent",
- "status": "absent",
- "image_build_status": "absent",
- "active_image_sha": null,
- "newest_image_sha": null
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/status",
- "log_lines": "/api/projects/opc/agents/agent1/status/log_lines"
}
}
]
}Updates an agent belonging to a project.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
required | object |
{- "data": {
- "attributes": {
- "name": "Modified",
- "description": "The updated agent",
- "archived": false,
- "regenerate_actions": true
}
}
}{- "data": {
- "id": "90517281-8262-40d0-acb1-e1d3fc3dd316",
- "type": "agent",
- "attributes": {
- "code": "agent1",
- "name": "blanditiis406",
- "description": "Voluptatibus velit qui expedita.",
- "archived": true,
- "created_by": "jennell",
- "actions": [ ],
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "1dbe0808-1b5a-4396-b00c-8a871327fe87",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/1dbe0808-1b5a-4396-b00c-8a871327fe87"
}
}, - "parents": {
- "data": [
- {
- "id": "20668993-515e-4632-af61-dc42e82ad1fa",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "3fcc5ee9-a58c-4a98-8c8b-cf3e7be8ac5d",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/3fcc5ee9-a58c-4a98-8c8b-cf3e7be8ac5d"
}
}, - "project": {
- "data": {
- "id": "20668993-515e-4632-af61-dc42e82ad1fa",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "a89307ea-6fa2-4e99-8bce-3edc6f0126e4",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/5bfb5cce-9de9-4cc6-a84b-e9a75516974c/versions/2026_Q1_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "5bfb5cce-9de9-4cc6-a84b-e9a75516974c",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/5bfb5cce-9de9-4cc6-a84b-e9a75516974c"
}
}, - "current_node_background_task": {
- "data": null,
- "links": {
- "related": null
}
}, - "agent_status": {
- "data": {
- "id": "31fb0955-bbd4-4ebb-a8e2-6e83be807a99",
- "type": "agent_status"
}, - "links": {
- "related": "/api/projects/opc/agents/agent1/status"
}
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1",
- "bookmarks": "/api/projects/opc/agents/agent1/bookmarks",
- "converged_properties": "/api/projects/opc/agents/agent1/converged_properties",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/agents/agent1/node_background_tasks",
- "version_history": "/api/projects/opc/agents/agent1/version_history"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": false
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
}Archives an agent belonging to a project.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find Node"
}
}
]
}Show the converged properties as they will appear for this agent. i.e. the endpoint will
The API response will also include all the individual repository and database properties that were included in the result.
| project_code required | string Example: opc project code |
| agent_code required | string Example: agent1 agent code |
| converge_date | string Example: converge_date=2026-02-23T07:57:32+00:00 Specify the date (and optionally time), to derive the active template version and agent properties from. |
{- "data": {
- "id": "agent1",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "repo": "project_properties",
- "common": "property",
- "project": "property",
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}, - "relationships": {
- "repository_properties": {
- "data": [
- {
- "id": "properties.yaml",
- "type": "repository_properties"
}, - {
- "id": "projects/opc.yaml",
- "type": "repository_properties"
}
]
}, - "properties": {
- "data": [
- {
- "id": "1ff0a2b7-294b-49f5-966b-578c9ff41020",
- "type": "properties_version"
}, - {
- "id": "4522e62d-1113-41ed-b369-9f6ffcca63d3",
- "type": "properties_version"
}, - {
- "id": "0f8225e6-a4fc-4b29-a952-debb8bb22408",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/agents/agent1/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "repo": "Repository: .opschain/projects/opc.yaml",
- "common": "Repository: .opschain/properties.yaml",
- "project": "Repository: .opschain/projects/opc.yaml",
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}
}, - "by_source": { }
}
}
}, - "included": [
- {
- "id": "1ff0a2b7-294b-49f5-966b-578c9ff41020",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-02-23T07:58:06.475471Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "64eb47e0-cca5-4665-9bc5-a6f3b1eef9fa",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/64eb47e0-cca5-4665-9bc5-a6f3b1eef9fa"
}
}
}, - "links": {
- "versions": "/api/properties/64eb47e0-cca5-4665-9bc5-a6f3b1eef9fa/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/64eb47e0-cca5-4665-9bc5-a6f3b1eef9fa/versions/1"
}, - "meta": { }
}, - {
- "id": "4522e62d-1113-41ed-b369-9f6ffcca63d3",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-02-23T07:58:06.512935Z",
- "owner_type": "Template version"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "3a1fa5eb-387c-45ef-952c-53e73db05f68",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/3a1fa5eb-387c-45ef-952c-53e73db05f68"
}
}
}, - "links": {
- "versions": "/api/properties/3a1fa5eb-387c-45ef-952c-53e73db05f68/versions",
- "owner": "/api/projects/opc/templates/bd14abe5-fb6e-4cf4-b86f-3bb708e03d8f/versions/2026_Q1_2",
- "self": "/api/properties/3a1fa5eb-387c-45ef-952c-53e73db05f68/versions/1"
}, - "meta": {
- "template_versions": {
- "2026_Q1_2": "0136aedb-8efc-4340-a4fa-e184ee71ba02"
}
}
}, - {
- "id": "0f8225e6-a4fc-4b29-a952-debb8bb22408",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-02-23T07:58:06.587296Z",
- "owner_type": "Agent"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "383093c4-bc4a-4ca9-9e41-f3ba71d615ce",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/383093c4-bc4a-4ca9-9e41-f3ba71d615ce"
}
}
}, - "links": {
- "versions": "/api/properties/383093c4-bc4a-4ca9-9e41-f3ba71d615ce/versions",
- "owner": "/api/projects/opc/agents/agent1",
- "self": "/api/properties/383093c4-bc4a-4ca9-9e41-f3ba71d615ce/versions/1"
}, - "meta": {
- "template_versions": {
- "2026_Q1_2": "0136aedb-8efc-4340-a4fa-e184ee71ba02"
}
}
}, - {
- "id": "properties.yaml",
- "type": "repository_properties",
- "attributes": {
- "content": {
- "repo": "base_properties",
- "common": "property"
}
}, - "links": {
- "repository_path": ".opschain/properties.yaml"
}
}, - {
- "id": "projects/opc.yaml",
- "type": "repository_properties",
- "attributes": {
- "content": {
- "repo": "project_properties",
- "project": "property"
}
}, - "links": {
- "repository_path": ".opschain/projects/opc.yaml"
}
}
]
}Endpoints to interact with assets.
Notes:
show and list response payloads include links to the asset's changes, scheduled activity, bookmarks and MintModels endpoints. These endpoints act like
the changes, scheduled activity, bookmarks and MintModels endpoints respectively./<path/to/asset/owner>/assets path. The example endpoints in this section reflect assets owned by a project.Lists all assets (including archived assets) that belong to the project.
Each asset in the response includes a link to:
changes endpoint for managing changes belonging to this asset. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this asset. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this asset. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this asset. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this asset's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this asset's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| filter[<query/sort filter>]= | |
| download | string Example: download=assets.csv Download the project assets in CSV format with the specified file name. The assets will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "f2b6b56e-d6d1-4eb6-92ab-28d5675971b6",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_by": "lynn",
- "actions": [
- {
- "name": "override",
- "children": [ ],
- "full_path": "override",
- "stage_step": false,
- "description": "If we transmit the application, we can get to the SDD hard drive through the auxiliary XSS hard drive!",
- "child_execution_strategy": "sequential"
}, - {
- "name": "provision",
- "description": "Provision resource on existing hardware"
}, - {
- "name": "quantify",
- "children": [ ],
- "full_path": "quantify",
- "stage_step": false,
- "description": "Navigating the matrix won't do anything, we need to compress the solid state xss panel!",
- "child_execution_strategy": "sequential"
}
], - "mintmodel_valid": true,
- "erb_file_content": null,
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "9fd86c41-b3d8-49b3-9ca8-1563efafd30c",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/9fd86c41-b3d8-49b3-9ca8-1563efafd30c"
}
}, - "parents": {
- "data": [
- {
- "id": "ea87ede6-5fd4-4c57-8781-9e54e30e8264",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "eecaaef4-d4e0-4213-a6c1-1f61495b16ab",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/eecaaef4-d4e0-4213-a6c1-1f61495b16ab"
}
}, - "project": {
- "data": {
- "id": "ea87ede6-5fd4-4c57-8781-9e54e30e8264",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "43186b3d-eb07-4a8f-bf47-6e9ca424a39d",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/62066b0b-e32f-44e8-8d4d-75f5b05517e4/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "6bfe8e18-00e9-4b96-8ccf-ac7a94dbfac4",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "62066b0b-e32f-44e8-8d4d-75f5b05517e4",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/62066b0b-e32f-44e8-8d4d-75f5b05517e4"
}
}, - "current_node_background_task": {
- "data": {
- "id": "c4ccb217-230f-4385-9630-87ead7bd93a5",
- "type": "node_background_task"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/node_background_tasks/c4ccb217-230f-4385-9630-87ead7bd93a5"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Creates an asset belonging to the project.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "template_code": "soa",
- "template_version": "2023_Q4_2"
}
}
}{- "data": {
- "id": "0d5515e8-48c5-4ebc-9868-1e2010adea50",
- "type": "asset",
- "attributes": {
- "code": "3lhm1",
- "name": "est432",
- "description": "Dignissimos ea sequi consectetur.",
- "archived": false,
- "created_by": "madelene",
- "actions": [
- {
- "name": "provision",
- "description": "Provision resource on existing hardware"
}
], - "mintmodel_valid": true,
- "erb_file_content": null,
- "task_active": true
}, - "relationships": {
- "properties": {
- "data": {
- "id": "db9256d8-da94-4f0e-a64d-2a58a2eca49a",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/db9256d8-da94-4f0e-a64d-2a58a2eca49a"
}
}, - "parents": {
- "data": [
- {
- "id": "107e9bed-1d34-42d6-ae66-ab411a0d8050",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "b80a96ef-67b0-4046-8fb1-6d76b7c3b518",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/b80a96ef-67b0-4046-8fb1-6d76b7c3b518"
}
}, - "project": {
- "data": {
- "id": "107e9bed-1d34-42d6-ae66-ab411a0d8050",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "354bab28-7629-41ce-8371-c53c3149039c",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/ab6bbc8c-37e6-45c2-abf4-77b50b39fe46/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [ ]
}, - "template": {
- "data": {
- "id": "ab6bbc8c-37e6-45c2-abf4-77b50b39fe46",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/ab6bbc8c-37e6-45c2-abf4-77b50b39fe46"
}
}, - "current_node_background_task": {
- "data": {
- "id": "432436ee-47b4-4aeb-9562-f4fe39057f36",
- "type": "node_background_task"
}, - "links": {
- "related": "/api/projects/opc/assets/3lhm1/node_background_tasks/432436ee-47b4-4aeb-9562-f4fe39057f36"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/3lhm1",
- "bookmarks": "/api/projects/opc/assets/3lhm1/bookmarks",
- "changes": "/api/projects/opc/assets/3lhm1/changes",
- "scheduled_activities": "/api/projects/opc/assets/3lhm1/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/3lhm1/converged_properties",
- "mintmodels": "/api/projects/opc/assets/3lhm1/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/3lhm1/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/3lhm1/node_background_tasks",
- "version_history": "/api/projects/opc/assets/3lhm1/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
}Shows an asset belonging to a project.
The response includes a link to:
changes endpoint for managing changes belonging to this asset. It acts like the changes endpoint.scheduled_activities endpoint for managing scheduled activities belonging to this asset. It acts like a scheduled activities endpoint.bookmarks endpoint for managing the bookmarks belonging to this asset. It acts like a bookmarks endpoint.mintmodels endpoint for managing the MintModels belonging to this asset. It acts like a MintModels endpoint.mintmodel_history endpoint for viewing this asset's MintModel history. It acts like a MintModel history endpoint.workflows endpoint for viewing this asset's workflows. It acts like a Workflows endpoint.
.| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": {
- "id": "b76ecc5f-ccf0-4542-8e41-1d57ca46b6d8",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_by": "assunta",
- "actions": [
- {
- "name": "compress",
- "children": [ ],
- "full_path": "compress",
- "stage_step": false,
- "description": "Try to override the EXE firewall, maybe it will quantify the 1080p port!",
- "child_execution_strategy": "sequential"
}, - {
- "name": "override",
- "children": [ ],
- "full_path": "override",
- "stage_step": false,
- "description": "Use the redundant HDD bus, then you can compress the wireless alarm!",
- "child_execution_strategy": "sequential"
}, - {
- "name": "provision",
- "description": "Provision resource on existing hardware"
}
], - "mintmodel_valid": true,
- "erb_file_content": "<MintModel erb file contents>",
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "363fc60f-951b-4231-8a79-3ee929b598ce",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/363fc60f-951b-4231-8a79-3ee929b598ce"
}
}, - "parents": {
- "data": [
- {
- "id": "b5a8e0cb-5124-412a-a8f2-0572aaa2337c",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "54138892-ffaf-4059-a4d7-34332d436013",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/54138892-ffaf-4059-a4d7-34332d436013"
}
}, - "project": {
- "data": {
- "id": "b5a8e0cb-5124-412a-a8f2-0572aaa2337c",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "ba9e475d-707f-4c23-a010-45ac833045e7",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/e95d7f23-e385-45a1-96ea-e6ff04b5515f/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "8344c89d-b1af-47e6-a5df-80a0bbd955be",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "e95d7f23-e385-45a1-96ea-e6ff04b5515f",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/e95d7f23-e385-45a1-96ea-e6ff04b5515f"
}
}, - "current_node_background_task": {
- "data": {
- "id": "46cad76b-887e-4431-89be-29f36b5e5296",
- "type": "node_background_task"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/node_background_tasks/46cad76b-887e-4431-89be-29f36b5e5296"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - "included": [
- {
- "id": "b5a8e0cb-5124-412a-a8f2-0572aaa2337c",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "fernando",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "c8651930-d6bf-4f5e-9cd0-445464a1c277",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/c8651930-d6bf-4f5e-9cd0-445464a1c277"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "44cfe810-58c6-4f4d-aaab-8b28aa478c26",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/44cfe810-58c6-4f4d-aaab-8b28aa478c26"
}
}, - "children": {
- "data": [
- {
- "id": "b76ecc5f-ccf0-4542-8e41-1d57ca46b6d8",
- "type": "asset"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - {
- "id": "8344c89d-b1af-47e6-a5df-80a0bbd955be",
- "type": "bookmark",
- "attributes": {
- "description": "SOA administration console",
- "created_by": "victor",
- "created_at": "2026-02-23T07:58:07.970120Z",
- "updated_at": "2026-02-23T07:58:07.970120Z"
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/8344c89d-b1af-47e6-a5df-80a0bbd955be",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}, - {
- "id": "e95d7f23-e385-45a1-96ea-e6ff04b5515f",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-02-23T07:58:07.834696Z",
- "updated_at": "2026-02-23T07:58:07.834696Z"
}, - "relationships": {
- "git_remote": {
- "data": {
- "id": "1bc597bd-8554-4976-8dbe-94cc3082d90d",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [
- {
- "id": "ba9e475d-707f-4c23-a010-45ac833045e7",
- "type": "template_version"
}
]
}, - "nodes": {
- "data": [
- {
- "id": "b76ecc5f-ccf0-4542-8e41-1d57ca46b6d8",
- "type": "asset"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/templates/e95d7f23-e385-45a1-96ea-e6ff04b5515f",
- "template_versions": "/api/projects/opc/templates/e95d7f23-e385-45a1-96ea-e6ff04b5515f/versions",
- "project": "/api/projects/opc"
}
}, - {
- "id": "ba9e475d-707f-4c23-a010-45ac833045e7",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "edward",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "created_at": "2026-02-23T07:58:07.858930Z",
- "updated_at": "2026-02-23T07:58:07.858930Z",
- "has_mintmodel": true,
- "git_rev": "haptic",
- "commit_sha": "d8429f9c1fca5c4e5e66fe5ed9a17f931dc1b92f",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "3422d6a4-0196-47d2-92fd-45617ee6c4e2",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/3422d6a4-0196-47d2-92fd-45617ee6c4e2"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/e95d7f23-e385-45a1-96ea-e6ff04b5515f/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/e95d7f23-e385-45a1-96ea-e6ff04b5515f"
}
}
]
}Updates an asset belonging to a project.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
required | object |
{- "data": {
- "attributes": {
- "name": "Modified",
- "description": "The updated asset",
- "archived": false,
- "regenerate_actions": true
}
}
}{- "data": {
- "id": "45af8c01-0b9e-427c-82eb-ad2757a06bc6",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "quos442",
- "description": "Quia voluptas expedita eius.",
- "archived": true,
- "created_by": "shiloh",
- "actions": [
- {
- "name": "provision",
- "description": "Provision resource on existing hardware"
}
], - "mintmodel_valid": true,
- "erb_file_content": null,
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "f792234f-aec6-4f4b-afa5-5ed839ef8f87",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/f792234f-aec6-4f4b-afa5-5ed839ef8f87"
}
}, - "parents": {
- "data": [
- {
- "id": "4189919d-4e82-4b84-8a31-7b8d549a632b",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "639e7afe-0e79-4e27-ab73-45a07cbda911",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/639e7afe-0e79-4e27-ab73-45a07cbda911"
}
}, - "project": {
- "data": {
- "id": "4189919d-4e82-4b84-8a31-7b8d549a632b",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "4de3e296-5b93-4a78-bff7-a24440806767",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/de733d07-3042-459d-92dc-4e2a00b34e3d/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "b1a08b1f-0b21-491a-aebb-8363dc94263a",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "de733d07-3042-459d-92dc-4e2a00b34e3d",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/de733d07-3042-459d-92dc-4e2a00b34e3d"
}
}, - "current_node_background_task": {
- "data": null,
- "links": {
- "related": null
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
}Archives an asset belonging to a project.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find Node"
}
}
]
}Show the converged properties as they will appear to actions run on this asset. i.e. the endpoint will
The API response will also include all the individual repository and database properties that were included in the result.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| converge_date | string Example: converge_date=2026-02-23T07:57:32+00:00 Specify the date (and optionally time), to derive the active template version and asset properties from. |
{- "data": {
- "id": "prj_soa",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "repo": "project_properties",
- "common": "property",
- "project": "property",
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}, - "relationships": {
- "repository_properties": {
- "data": [
- {
- "id": "properties.yaml",
- "type": "repository_properties"
}, - {
- "id": "projects/opc.yaml",
- "type": "repository_properties"
}
]
}, - "properties": {
- "data": [
- {
- "id": "c32d4eb1-5edf-4dd9-9931-2218dffa3388",
- "type": "properties_version"
}, - {
- "id": "ce2f5b47-2fc0-418d-8213-5e7a308d9fb7",
- "type": "properties_version"
}, - {
- "id": "a1d70a03-5476-4948-a295-d069c7d890e2",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "repo": "Repository: .opschain/projects/opc.yaml",
- "common": "Repository: .opschain/properties.yaml",
- "project": "Repository: .opschain/projects/opc.yaml",
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}
}, - "by_source": { }
}
}
}, - "included": [
- {
- "id": "c32d4eb1-5edf-4dd9-9931-2218dffa3388",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-02-23T07:58:09.800211Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "f559cb14-1b78-4cca-bad3-5e7b75dbb37b",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/f559cb14-1b78-4cca-bad3-5e7b75dbb37b"
}
}
}, - "links": {
- "versions": "/api/properties/f559cb14-1b78-4cca-bad3-5e7b75dbb37b/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/f559cb14-1b78-4cca-bad3-5e7b75dbb37b/versions/1"
}, - "meta": { }
}, - {
- "id": "ce2f5b47-2fc0-418d-8213-5e7a308d9fb7",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-02-23T07:58:09.837065Z",
- "owner_type": "Template version"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "9b8b5f6c-2725-4493-a0be-bbfe2927cea7",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/9b8b5f6c-2725-4493-a0be-bbfe2927cea7"
}
}
}, - "links": {
- "versions": "/api/properties/9b8b5f6c-2725-4493-a0be-bbfe2927cea7/versions",
- "owner": "/api/projects/opc/templates/8102cf7b-c2ab-497c-8fdd-fb01060fa20e/versions/2023_Q4_2",
- "self": "/api/properties/9b8b5f6c-2725-4493-a0be-bbfe2927cea7/versions/1"
}, - "meta": {
- "template_versions": {
- "2023_Q4_2": "2677ec17-6ff4-41cc-9744-0f5c5500fe01"
}
}
}, - {
- "id": "a1d70a03-5476-4948-a295-d069c7d890e2",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-02-23T07:58:09.899426Z",
- "owner_type": "Asset"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "a03e8397-f8d5-4326-90bd-12c338ce5572",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/a03e8397-f8d5-4326-90bd-12c338ce5572"
}
}
}, - "links": {
- "versions": "/api/properties/a03e8397-f8d5-4326-90bd-12c338ce5572/versions",
- "owner": "/api/projects/opc/assets/prj_soa",
- "self": "/api/properties/a03e8397-f8d5-4326-90bd-12c338ce5572/versions/1"
}, - "meta": {
- "template_versions": {
- "2023_Q4_2": "2677ec17-6ff4-41cc-9744-0f5c5500fe01"
}
}
}, - {
- "id": "properties.yaml",
- "type": "repository_properties",
- "attributes": {
- "content": {
- "repo": "base_properties",
- "common": "property"
}
}, - "links": {
- "repository_path": ".opschain/properties.yaml"
}
}, - {
- "id": "projects/opc.yaml",
- "type": "repository_properties",
- "attributes": {
- "content": {
- "repo": "project_properties",
- "project": "property"
}
}, - "links": {
- "repository_path": ".opschain/projects/opc.yaml"
}
}
]
}List the log lines generated while building an image and querying the actions available for this asset / template version combination.
Note: See the list filtered log lines API docs for filtering options.
| node_background_task_id required | string Example: 87cbabda-6631-4f11-98f5-1e3bd54421ae |
| filter[<query/sort filter>]= | |
| download | string Example: download=change.log Download the log lines with the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "2195a39e-47d7-4962-89d5-8837c7488e5f",
- "type": "node_background_task_log_line",
- "attributes": {
- "message": "Ut libero sit doloremque.",
- "category": "action",
- "template_version_history_id": "77961dc5-d355-4db1-b67a-b91a0aad0e2f",
- "node_background_task_id": "19b94a3d-c26c-4f37-995d-e08a1c1f2e4d",
- "logged_at": "2026-02-22T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Create a request to refresh the actions list for an asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": {
- "id": "ef762b72-0c4f-4355-a582-cde9bf8d72bf",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "initializing",
- "error_message": null,
- "created_by": "slyvia.marquardt",
- "actions": [ ],
- "task_type": "GenerateActionsRequest",
- "created_at": "2026-02-23T07:58:10.759203Z",
- "updated_at": "2026-02-23T07:58:10.759203Z"
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "2d46aef4-95ff-484b-a3c5-f483ee1783e7",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "cc1142a5-1ce7-4dff-983c-28ee1d8e27aa",
- "type": "asset"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/9195a1f8-4135-4ec5-8ac7-9409b88d919d/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/ef762b72-0c4f-4355-a582-cde9bf8d72bf",
- "asset": "/api/projects/opc/assets/prj_soa",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=ef762b72-0c4f-4355-a582-cde9bf8d72bf"
}
}
}Lists all generate actions requests made for the asset's current template version.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": [
- {
- "id": "ab1807b5-c32a-4bab-b110-6708320cb8b1",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "terrence",
- "actions": [
- {
- "name": "hack",
- "children": [ ],
- "full_path": "hack",
- "stage_step": false,
- "description": "You can't synthesize the monitor without navigating the back-end JBOD bus!",
- "child_execution_strategy": "sequential"
}, - {
- "name": "input",
- "children": [ ],
- "full_path": "input",
- "stage_step": false,
- "description": "Try to back up the XML hard drive, maybe it will reboot the neural hard drive!",
- "child_execution_strategy": "sequential"
}
], - "task_type": "GenerateActionsRequest",
- "created_at": "2026-02-23T07:58:10.931788Z",
- "updated_at": "2026-02-23T07:58:10.937951Z"
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "d89ce86a-dfe0-4706-af7e-2554e5eadb72",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "b0982af8-633a-45fe-a41a-7c45a5348061",
- "type": "asset"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/f4c8484f-2cb9-48ea-a02d-02624273800b/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/ab1807b5-c32a-4bab-b110-6708320cb8b1",
- "asset": "/api/projects/opc/assets/prj_soa",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=ab1807b5-c32a-4bab-b110-6708320cb8b1"
}
}
], - "meta": {
- "authorisations": {
- "update": false
}
}
}Show a specific actions generation request.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| node_background_task_id required | string Example: 87cbabda-6631-4f11-98f5-1e3bd54421ae generate actions request id |
{- "data": {
- "id": "4ea23817-fa71-4f5d-aac9-465225919e0d",
- "type": "node_background_task",
- "attributes": {
- "request_number": 1,
- "status_code": "success",
- "error_message": null,
- "created_by": "rudy",
- "actions": [
- {
- "name": "compress",
- "children": [ ],
- "full_path": "compress",
- "stage_step": false,
- "description": "You can't quantify the card without backing up the back-end SDD interface!",
- "child_execution_strategy": "sequential"
}, - {
- "name": "program",
- "children": [ ],
- "full_path": "program",
- "stage_step": false,
- "description": "You can't index the feed without navigating the online TCP bus!",
- "child_execution_strategy": "sequential"
}
], - "task_type": "GenerateActionsRequest",
- "created_at": "2026-02-23T07:58:11.130517Z",
- "updated_at": "2026-02-23T07:58:11.136930Z"
}, - "relationships": {
- "template_version_history": {
- "data": {
- "id": "45d01d45-872b-45da-abfc-0cb19451d1e6",
- "type": "template_version_history"
}
}, - "owner": {
- "data": {
- "id": "2f1880f0-b6a1-498b-8c74-f02978b16a2c",
- "type": "asset"
}
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/734d2fab-c93b-49da-a5e3-241b34e23ed2/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/node_background_tasks/4ea23817-fa71-4f5d-aac9-465225919e0d",
- "asset": "/api/projects/opc/assets/prj_soa",
- "log_lines": "/api/node_background_task_log_lines?node_background_task_id=4ea23817-fa71-4f5d-aac9-465225919e0d"
}
}
}Cancels the generate actions request.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| node_background_task_id required | string Example: 87cbabda-6631-4f11-98f5-1e3bd54421ae generate actions request id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find NodeBackgroundTask"
}
}
]
}Lists all properties versions and template versions for the asset and its parents.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": [
- {
- "id": "383af9f2-ef71-436b-9fa2-cb5e841c68bf",
- "type": "project",
- "attributes": {
- "level": 0,
- "code": "opc",
- "name": "OpsChain",
- "properties_versions": [
- {
- "version": 1,
- "start_date": "2026-02-23T07:58:17Z"
}
]
}
}, - {
- "id": "1382a38d-c239-4e8f-8448-e8b61a553684",
- "type": "asset",
- "attributes": {
- "level": 2,
- "code": "prj_soa",
- "name": "Project asset",
- "properties_versions": [
- {
- "version": 1,
- "start_date": "2026-02-23T07:58:17Z"
}
], - "template_versions": [ ]
}
}
]
}Lists the template versions that have been assigned to the asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| filter[<query/sort filter>]= |
{- "data": [
- {
- "id": "e2c6773e-995d-4e3d-884d-2d61445097b6",
- "type": "template_version_history",
- "attributes": {
- "created_by": "dallas",
- "active_from": "2026-02-23T07:58:30.578836Z",
- "active_to": null
}, - "relationships": {
- "owner": {
- "data": {
- "id": "c6a93e34-4fb4-4585-8f80-3129741308c0",
- "type": "asset"
}
}, - "template_version": {
- "data": {
- "id": "e385df3f-55b0-48e3-8029-c248daef0a1b",
- "type": "template_version"
}
}, - "node_background_tasks": {
- "data": [
- {
- "id": "05aa8032-e8c4-4dee-8abb-f8c0267c9924",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/d839a2b3-b614-424c-a18f-c9ed79d912d9/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/version_history/e2c6773e-995d-4e3d-884d-2d61445097b6",
- "asset": "/api/projects/opc/assets/prj_soa"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Shows a specific project asset's template version history record.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| id required | string Example: 4a6a18a2-a424-439b-bea2-8d2dcfdfbc50 version history id |
{- "data": {
- "id": "02373318-7803-437d-9ed0-7c5e9a2e34e6",
- "type": "template_version_history",
- "attributes": {
- "created_by": "paul",
- "active_from": "2026-02-23T07:58:30.740452Z",
- "active_to": null
}, - "relationships": {
- "owner": {
- "data": {
- "id": "60287268-c8ef-441d-918c-dc51dd347d0b",
- "type": "asset"
}
}, - "template_version": {
- "data": {
- "id": "4632ef99-ad4f-4d1e-a45a-bfabbfa7d0b9",
- "type": "template_version"
}
}, - "node_background_tasks": {
- "data": [
- {
- "id": "911989ca-5185-4d11-8e92-f8ee24bd4638",
- "type": "node_background_task"
}
]
}
}, - "links": {
- "template_version": "/api/projects/opc/templates/77f76182-4b8b-4da9-b743-812c93d5b4f5/versions/2023_Q4_2",
- "self": "/api/projects/opc/assets/prj_soa/version_history/02373318-7803-437d-9ed0-7c5e9a2e34e6",
- "asset": "/api/projects/opc/assets/prj_soa"
}
}, - "included": [
- {
- "id": "60287268-c8ef-441d-918c-dc51dd347d0b",
- "type": "asset",
- "attributes": {
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_by": "paul",
- "actions": [
- {
- "name": "copy",
- "children": [ ],
- "full_path": "copy",
- "stage_step": false,
- "description": "You can't generate the program without indexing the multi-byte FTP driver!",
- "child_execution_strategy": "sequential"
}, - {
- "name": "program",
- "children": [ ],
- "full_path": "program",
- "stage_step": false,
- "description": "The CSS monitor is down, program the auxiliary capacitor so we can hack the SDD program!",
- "child_execution_strategy": "sequential"
}, - {
- "name": "provision",
- "description": "Provision resource on existing hardware"
}
], - "mintmodel_valid": true,
- "erb_file_content": null,
- "task_active": false
}, - "relationships": {
- "properties": {
- "data": {
- "id": "047a7c44-aceb-4122-9b30-b30d24b81576",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/047a7c44-aceb-4122-9b30-b30d24b81576"
}
}, - "parents": {
- "data": [
- {
- "id": "260c4e05-2c4e-438b-981d-053a23337737",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "a39a7858-362a-4b17-b5a2-a0511567f58c",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/a39a7858-362a-4b17-b5a2-a0511567f58c"
}
}, - "project": {
- "data": {
- "id": "260c4e05-2c4e-438b-981d-053a23337737",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "template_version": {
- "data": {
- "id": "4632ef99-ad4f-4d1e-a45a-bfabbfa7d0b9",
- "type": "template_version"
}, - "links": {
- "related": "/api/projects/opc/templates/77f76182-4b8b-4da9-b743-812c93d5b4f5/versions/2023_Q4_2"
}
}, - "bookmarks": {
- "data": [
- {
- "id": "a6b8022f-9b88-495d-9758-855c58b7a84c",
- "type": "bookmark"
}
]
}, - "template": {
- "data": {
- "id": "77f76182-4b8b-4da9-b743-812c93d5b4f5",
- "type": "template"
}, - "links": {
- "related": "/api/projects/opc/templates/77f76182-4b8b-4da9-b743-812c93d5b4f5"
}
}, - "current_node_background_task": {
- "data": {
- "id": "911989ca-5185-4d11-8e92-f8ee24bd4638",
- "type": "node_background_task"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/node_background_tasks/911989ca-5185-4d11-8e92-f8ee24bd4638"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa",
- "bookmarks": "/api/projects/opc/assets/prj_soa/bookmarks",
- "changes": "/api/projects/opc/assets/prj_soa/changes",
- "scheduled_activities": "/api/projects/opc/assets/prj_soa/scheduled_activities",
- "converged_properties": "/api/projects/opc/assets/prj_soa/converged_properties",
- "mintmodels": "/api/projects/opc/assets/prj_soa/mintmodels",
- "mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history",
- "parent": "/api/projects/opc",
- "node_background_tasks": "/api/projects/opc/assets/prj_soa/node_background_tasks",
- "version_history": "/api/projects/opc/assets/prj_soa/version_history"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": false,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": true,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - {
- "id": "4632ef99-ad4f-4d1e-a45a-bfabbfa7d0b9",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "latoya_gulgowski",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "created_at": "2026-02-23T07:58:30.710374Z",
- "updated_at": "2026-02-23T07:58:30.710374Z",
- "has_mintmodel": true,
- "git_rev": "open-source",
- "commit_sha": "bf3168233ce2cd3b542c6735941fad55e408dbde",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "02aefba4-8f2b-4e56-a118-123444d10262",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/02aefba4-8f2b-4e56-a118-123444d10262"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/77f76182-4b8b-4da9-b743-812c93d5b4f5/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/77f76182-4b8b-4da9-b743-812c93d5b4f5"
}
}
]
}Templates provide the available actions and a base set of repository properties that will be used to configure the asset.
Lists all versions of a specific template.
| project_code required | string Example: opc project code |
| template_id required | string Example: 46bd1b9c-0de3-48fa-afa2-f4d7850152c9 template id |
{- "data": [
- {
- "id": "e91e053f-eeda-4da9-8008-52177003ccaf",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "ginger",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "created_at": "2026-02-23T07:58:30.972219Z",
- "updated_at": "2026-02-23T07:58:30.972219Z",
- "has_mintmodel": true,
- "git_rev": "1080p",
- "commit_sha": "7121f3a4d7260f0611ab0f5cd63700b6f4aae124",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "a08eb290-2fb6-4f9b-94d2-b08da2565a2d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/a08eb290-2fb6-4f9b-94d2-b08da2565a2d"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/83545b9d-bca2-4054-b3c0-06c304a8dd57/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/83545b9d-bca2-4054-b3c0-06c304a8dd57"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Create or update a template version.
| project_code required | string Example: opc project code |
| template_id required | string Example: 46bd1b9c-0de3-48fa-afa2-f4d7850152c9 template id |
| version required | string Example: 2023_Q4_2 template version |
required | object |
object |
{- "data": {
- "attributes": {
- "description": "Added additional configuration options",
- "git_rev": "wireless",
- "archived": "false",
- "locked": "false"
}
}, - "meta": {
- "ignore_in_use": false,
- "fetch_revision": false
}
}{- "data": {
- "id": "e3e148bc-c384-4661-a5c2-ccff3a5bf056",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Iusto cupiditate excepturi consequatur magnam nostrum sint asperiores maxime",
- "state": "initializing",
- "created_by": "terrell",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "created_at": "2026-02-23T07:58:31.695103Z",
- "updated_at": "2026-02-23T07:58:31.695103Z",
- "has_mintmodel": false,
- "git_rev": "mobile",
- "commit_sha": null,
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "8e474909-975f-4a8f-b8a9-ad5abf64b6c3",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/8e474909-975f-4a8f-b8a9-ad5abf64b6c3"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/890eac20-924f-41d0-b8b8-51c56828e9d3/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/890eac20-924f-41d0-b8b8-51c56828e9d3"
}
}
}Shows a specific template version.
| project_code required | string Example: opc project code |
| template_id required | string Example: 46bd1b9c-0de3-48fa-afa2-f4d7850152c9 template id |
| version required | string Example: 2023_Q4_2 template version |
{- "data": {
- "id": "280e3fbc-9bad-4813-b720-4968bddb6170",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "crystal",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "created_at": "2026-02-23T07:58:32.203636Z",
- "updated_at": "2026-02-23T07:58:32.203636Z",
- "has_mintmodel": true,
- "git_rev": "virtual",
- "commit_sha": "8ef2fc9e49c637252a3aed60da2573e32455c1b8",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "0f04e2a4-e324-4235-9623-425360fc13b6",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/0f04e2a4-e324-4235-9623-425360fc13b6"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/4bfed7fa-8653-4dc4-a31f-90831530f1b4/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/4bfed7fa-8653-4dc4-a31f-90831530f1b4"
}
}, - "meta": {
- "authorisations": {
- "update": true
}
}
}Assign assets to the template version.
| project_code required | string Example: opc project code |
| template_id required | string Example: 46bd1b9c-0de3-48fa-afa2-f4d7850152c9 template id |
| version required | string Example: 2023_Q4_2 template version |
required | object |
{- "data": {
- "attributes": {
- "asset_paths": [
- "/projects/opc/assets/prj_soa"
]
}
}
}{- "data": {
- "id": "9b3da9a1-5ccd-4994-8e9c-c74d2031d57a",
- "type": "template_version",
- "attributes": {
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "state": "ready",
- "created_by": "kory.ohara",
- "archived": false,
- "initialization_error": null,
- "locked": false,
- "created_at": "2026-02-23T07:58:32.383533Z",
- "updated_at": "2026-02-23T07:58:32.383533Z",
- "has_mintmodel": true,
- "git_rev": "optical",
- "commit_sha": "b7c7c08b4c75dc60d84d6cd85b41f3d858d8081b",
- "git_remote_name": "github"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "f9aefa3e-9b5a-4f98-a1d2-fc7c5ef96d33",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/f9aefa3e-9b5a-4f98-a1d2-fc7c5ef96d33"
}
}
}, - "links": {
- "self": "/api/projects/opc/templates/4122fd2f-4aa3-4c0b-971d-f95365e22bd9/versions/2023_Q4_2",
- "template": "/api/projects/opc/templates/4122fd2f-4aa3-4c0b-971d-f95365e22bd9"
}
}
}Create a template.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "template_type": "asset",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "git_remote_name": "github"
}
}
}{- "data": {
- "id": "7c158f7f-ecc7-4c72-9375-da1a42951a76",
- "type": "template",
- "attributes": {
- "code": "cmu0f",
- "name": "kayleigh",
- "description": "Sunt debitis qui omnis.",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-02-23T07:58:32.863658Z",
- "updated_at": "2026-02-23T07:58:32.863658Z"
}, - "relationships": {
- "git_remote": {
- "data": {
- "id": "b391f5cb-3619-47fa-a17d-3988bae574dd",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/templates/7c158f7f-ecc7-4c72-9375-da1a42951a76",
- "template_versions": "/api/projects/opc/templates/7c158f7f-ecc7-4c72-9375-da1a42951a76/versions",
- "project": "/api/projects/opc"
}
}
}Lists all templates for a project.
| project_code required | string Example: opc project code |
{- "data": [
- {
- "id": "a4300f01-f3a4-4891-b275-3d509a6d8821",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-02-23T07:58:33.294488Z",
- "updated_at": "2026-02-23T07:58:33.294488Z"
}, - "relationships": {
- "git_remote": {
- "data": {
- "id": "13619ff8-478a-47c0-8f90-46499cc990cc",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/templates/a4300f01-f3a4-4891-b275-3d509a6d8821",
- "template_versions": "/api/projects/opc/templates/a4300f01-f3a4-4891-b275-3d509a6d8821/versions",
- "project": "/api/projects/opc"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Shows a project template.
| project_code required | string Example: opc project code |
| template_id required | string Example: 46bd1b9c-0de3-48fa-afa2-f4d7850152c9 template id |
{- "data": {
- "id": "161071f0-a161-4f03-9d0e-83442d12e170",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-02-23T07:58:33.485854Z",
- "updated_at": "2026-02-23T07:58:33.485854Z"
}, - "relationships": {
- "git_remote": {
- "data": {
- "id": "f9fe7358-a60c-4444-accd-4155a1b5870c",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/templates/161071f0-a161-4f03-9d0e-83442d12e170",
- "template_versions": "/api/projects/opc/templates/161071f0-a161-4f03-9d0e-83442d12e170/versions",
- "project": "/api/projects/opc"
}
}, - "meta": {
- "authorisations": {
- "update": true
}
}
}Archives/unarchives a template.
| project_code required | string Example: opc project code |
| id_to_archive required | string Example: 46bd1b9c-0de3-48fa-afa2-f4d7850152c9 template id |
required | object |
{- "data": {
- "attributes": {
- "archived": true
}
}
}{- "data": {
- "id": "a93d6806-f500-4096-a165-975652fd76cd",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "archived": true,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-02-23T07:58:33.658044Z",
- "updated_at": "2026-02-23T07:58:33.689148Z"
}, - "relationships": {
- "git_remote": {
- "data": {
- "id": "c2787900-614d-4a68-ae2a-10d02f8c3f04",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/templates/a93d6806-f500-4096-a165-975652fd76cd",
- "template_versions": "/api/projects/opc/templates/a93d6806-f500-4096-a165-975652fd76cd/versions",
- "project": "/api/projects/opc"
}
}
}Update a templates details.
| project_code required | string Example: opc project code |
| id_to_update required | string Example: 46bd1b9c-0de3-48fa-afa2-f4d7850152c9 template id |
required | object |
{- "data": {
- "attributes": {
- "name": "Oracle SOA template",
- "description": "Oracle SOA Suite 12c (12.2.1.4.0)",
- "git_remote_name": "github",
- "disabled": false
}
}
}{- "data": {
- "id": "0cbbcc7e-5c52-4784-a496-5d056b1b3c01",
- "type": "template",
- "attributes": {
- "code": "soa",
- "name": "updated_name",
- "description": "updated_description",
- "archived": false,
- "disabled": false,
- "template_type": "asset",
- "created_at": "2026-02-23T07:58:33.939197Z",
- "updated_at": "2026-02-23T07:58:33.959288Z"
}, - "relationships": {
- "git_remote": {
- "data": {
- "id": "cfaf479e-6c84-43b8-a305-95965a8e153d",
- "type": "git_remote"
}
}, - "template_versions": {
- "data": [ ]
}, - "nodes": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/templates/0cbbcc7e-5c52-4784-a496-5d056b1b3c01",
- "template_versions": "/api/projects/opc/templates/0cbbcc7e-5c52-4784-a496-5d056b1b3c01/versions",
- "project": "/api/projects/opc"
}
}
}Endpoints to interact with git remotes.
Create a project Git remote.
| project_code required | string Example: opc project code |
required | object |
{- "data": {
- "attributes": {
- "name": "github",
- "user": "limepoint",
- "password": "password",
- "ssh_key_data": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----\n"
}
}
}{- "data": {
- "id": "bad7f136-573a-4d34-8aee-453f898d82a6",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": false,
- "disabled": false,
- "created_at": "2026-02-23T07:57:58.671422Z",
- "updated_at": "2026-02-23T07:57:58.671422Z",
- "user": null,
- "password": null,
- "ssh_key_data": null
}, - "relationships": {
- "templates": {
- "data": [ ]
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/bad7f136-573a-4d34-8aee-453f898d82a6"
}, - "meta": null
}
}Lists all Git remotes for a project.
| project_code required | string Example: opc project code |
{- "data": [
- {
- "id": "faef11da-c427-45a4-98bd-a845e49cc66e",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": false,
- "disabled": false,
- "created_at": "2026-02-23T07:57:59.144656Z",
- "updated_at": "2026-02-23T07:57:59.144656Z",
- "user": "{{hidden}}",
- "password": "{{hidden}}",
- "ssh_key_data": "{{hidden}}"
}, - "relationships": {
- "templates": {
- "data": [ ]
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/faef11da-c427-45a4-98bd-a845e49cc66e"
}, - "meta": null
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Shows a project Git remote.
Note: Git remote credentials are obfuscated for security reasons.
| project_code required | string Example: opc project code |
| remote_id required | string Example: 3c65c7c0-797f-4857-9e0e-efbe42a3fe1e remote id |
{- "data": {
- "id": "4c4985d2-be65-487e-9090-e6b6bdf2ea73",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": false,
- "disabled": false,
- "created_at": "2026-02-23T07:57:59.372470Z",
- "updated_at": "2026-02-23T07:57:59.372470Z",
- "user": "{{hidden}}",
- "password": "{{hidden}}",
- "ssh_key_data": "{{hidden}}"
}, - "relationships": {
- "templates": {
- "data": [ ]
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/4c4985d2-be65-487e-9090-e6b6bdf2ea73"
}, - "meta": null
}
}Archives/unarchives a project Git remote.
| project_code required | string Example: opc project code |
| id_to_archive required | string Example: 3c65c7c0-797f-4857-9e0e-efbe42a3fe1e remote id |
required | object |
{- "data": {
- "attributes": {
- "archived": true
}
}
}{- "data": {
- "id": "a5462d4c-ff52-43e6-8f73-f9d6e3b59a62",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": true,
- "disabled": false,
- "created_at": "2026-02-23T07:57:59.587260Z",
- "updated_at": "2026-02-23T07:57:59.628812Z",
- "user": "{{hidden}}",
- "password": "{{hidden}}",
- "ssh_key_data": "{{hidden}}"
}, - "relationships": {
- "templates": {
- "data": [ ]
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/a5462d4c-ff52-43e6-8f73-f9d6e3b59a62"
}, - "meta": null
}
}Update the credentials of a project Git remote.
| project_code required | string Example: opc project code |
| id_to_update required | string Example: 3c65c7c0-797f-4857-9e0e-efbe42a3fe1e remote id |
required | object |
{- "data": {
- "attributes": {
- "user": "limepoint",
- "password": "password",
- "ssh_key_data": "-----BEGIN OPENSSH PRIVATE KEY-----\n...\n-----END OPENSSH PRIVATE KEY-----\n"
}
}
}{- "data": {
- "id": "638b48f6-eea7-438c-9930-84efa5f671fd",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": false,
- "disabled": false,
- "created_at": "2026-02-23T07:58:00.021491Z",
- "updated_at": "2026-02-23T07:58:00.052019Z",
- "user": "{{hidden}}",
- "password": "{{hidden}}",
- "ssh_key_data": "{{hidden}}"
}, - "relationships": {
- "templates": {
- "data": [ ]
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/638b48f6-eea7-438c-9930-84efa5f671fd"
}, - "meta": null
}
}Deletes a project Git remote if it has no changes, otherwise it removes the credentials.
| project_code required | string Example: opc project code |
| id_to_delete required | string Example: 3c65c7c0-797f-4857-9e0e-efbe42a3fe1e remote id |
{- "data": {
- "id": "45155df8-c428-4538-85ba-e802faa3da14",
- "type": "git_remote",
- "attributes": {
- "name": "github",
- "archived": true,
- "disabled": false,
- "created_at": "2026-02-23T07:58:00.513942Z",
- "updated_at": "2026-02-23T07:58:00.712550Z",
- "user": null,
- "password": null,
- "ssh_key_data": null
}, - "relationships": {
- "templates": {
- "data": [ ]
}
}, - "links": {
- "project": "/api/projects/opc",
- "templates": "/api/projects/opc/templates?filter%5Bgit_remote_name_eq%5D=github",
- "self": "/api/projects/opc/git_remotes/45155df8-c428-4538-85ba-e802faa3da14"
}, - "meta": {
- "credentials_removed": true,
- "messages": [
- "This Git remote cannot be deleted as it is used by a change, its credentials have been removed."
]
}
}
}Endpoints to interact with bookmarks.
Notes:
/<path/to/bookmark/owner>/bookmarks path. The example endpoints in this section reflect bookmarks owned
by a project asset.Create a bookmark for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
required | object |
{- "data": {
- "attributes": {
- "description": "SOA administration console",
- "created_by": "mickie_yundt"
}
}
}{- "data": {
- "id": "136d165a-9ed5-4e7a-8696-6d9bd8dbd327",
- "type": "bookmark",
- "attributes": {
- "description": "Modi dicta distinctio natus.",
- "created_by": "corazon.auer",
- "created_at": "2026-02-23T07:57:51.026836Z",
- "updated_at": "2026-02-23T07:57:51.026836Z"
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/136d165a-9ed5-4e7a-8696-6d9bd8dbd327",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}
}Lists all bookmarks for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": [
- {
- "id": "5a66544a-7ef3-4524-97cd-6c2f545fdf83",
- "type": "bookmark",
- "attributes": {
- "description": "SOA administration console",
- "created_by": "libbie",
- "created_at": "2026-02-23T07:57:51.665166Z",
- "updated_at": "2026-02-23T07:57:51.665166Z"
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/5a66544a-7ef3-4524-97cd-6c2f545fdf83",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Show a bookmark for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| bookmark_id required | string Example: aae7bb72-73d8-4da8-88d8-e3be5029015e bookmark id |
{- "data": {
- "id": "d1afa39c-2a11-4257-8811-591eb2267fac",
- "type": "bookmark",
- "attributes": {
- "description": "SOA administration console",
- "created_by": "renee.lindgren",
- "created_at": "2026-02-23T07:57:51.881014Z",
- "updated_at": "2026-02-23T07:57:51.881014Z"
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/d1afa39c-2a11-4257-8811-591eb2267fac",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}
}Update a bookmark for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| bookmark_id required | string Example: aae7bb72-73d8-4da8-88d8-e3be5029015e bookmark id |
required | object |
{- "data": {
- "attributes": {
- "description": "Updated server console path"
}
}
}{- "data": {
- "id": "8273c084-eb94-4e7f-ac2e-0380e176aa4c",
- "type": "bookmark",
- "attributes": {
- "description": "Updated server console path",
- "created_by": "francina.leannon",
- "created_at": "2026-02-23T07:57:52.315754Z",
- "updated_at": "2026-02-23T07:57:52.361877Z"
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/bookmarks/8273c084-eb94-4e7f-ac2e-0380e176aa4c",
- "parent": "/api/projects/opc/assets/prj_soa"
}
}
}Delete a bookmark for a specific project, environment or asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| bookmark_id required | string Example: aae7bb72-73d8-4da8-88d8-e3be5029015e bookmark id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find Bookmark"
}
}
]
}Endpoints to query and generate MintModels for assets.
Notes:
parent_mintmodel_history link in the API response to access the
asset's MintModel history.Lists the asset's MintModel history.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": [
- {
- "id": "8a206b24-8569-4a28-879e-b7da418d6fb3",
- "type": "mintmodel_history",
- "attributes": {
- "created_at": "2026-02-23T07:58:02.115608Z",
- "updated_at": "2026-02-23T07:58:02.115608Z"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "ec1140e3-a81d-4a6d-b050-3a0447dea044",
- "type": "project"
}, - {
- "id": "66adb2c4-f8f1-4f4d-908d-28fd0964b8db",
- "type": "asset"
}
]
}, - "mintmodel": {
- "data": {
- "id": "46d081c7-b193-44cc-bac6-af544b91d9f0",
- "type": "mintmodel"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/mintmodels/46d081c7-b193-44cc-bac6-af544b91d9f0"
}
}, - "opschain_changes": {
- "data": [ ]
}, - "template_version": {
- "data": {
- "id": "662f1320-c7d7-4abd-9ae0-9e737b9afc16",
- "type": "template_version"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodel_history/8a206b24-8569-4a28-879e-b7da418d6fb3"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Shows an asset's MintModel history record.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| id required | string Example: 48757a9c-3641-4869-a8c0-de2f36bb386b MintModel history id |
{- "data": {
- "id": "73af150e-b812-442b-ab5c-a3420d41e9ac",
- "type": "mintmodel_history",
- "attributes": {
- "created_at": "2026-02-23T07:58:02.355617Z",
- "updated_at": "2026-02-23T07:58:02.355617Z"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "fb2800ee-48e1-478b-91c5-585bb3ed91bb",
- "type": "project"
}, - {
- "id": "0d62bcde-5ae6-4faf-bafb-d598d646c86c",
- "type": "asset"
}
]
}, - "mintmodel": {
- "data": {
- "id": "3974309f-b701-4eb2-ad75-20c1ad32685e",
- "type": "mintmodel"
}, - "links": {
- "related": "/api/projects/opc/assets/prj_soa/mintmodels/3974309f-b701-4eb2-ad75-20c1ad32685e"
}
}, - "opschain_changes": {
- "data": [ ]
}, - "template_version": {
- "data": {
- "id": "635e7ccf-05db-4943-a3be-65bd64bf14ac",
- "type": "template_version"
}
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodel_history/73af150e-b812-442b-ab5c-a3420d41e9ac"
}
}, - "included": [
- {
- "id": "3974309f-b701-4eb2-ad75-20c1ad32685e",
- "type": "mintmodel",
- "attributes": {
- "data": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
- "created_at": "2026-02-23T07:58:02.349319Z",
- "updated_at": "2026-02-23T07:58:02.349319Z",
- "render_logs": "[\"MintPress renderer output\"]"
}, - "relationships": {
- "mintmodel_history": {
- "data": [
- {
- "id": "73af150e-b812-442b-ab5c-a3420d41e9ac",
- "type": "mintmodel_history"
}, - {
- "id": "aabcb9a9-4bb2-4096-95e2-2de8876a6eb7",
- "type": "mintmodel_history"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodels/3974309f-b701-4eb2-ad75-20c1ad32685e",
- "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
}
}
]
}List all MintModels for an asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": [
- {
- "id": "9dd0466f-8a13-4ee8-a3b1-572d09e6c4ce",
- "type": "mintmodel",
- "attributes": {
- "data": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
- "created_at": "2026-02-23T07:58:02.463937Z",
- "updated_at": "2026-02-23T07:58:02.463937Z",
- "render_logs": "[\"MintPress renderer output\"]"
}, - "relationships": {
- "mintmodel_history": {
- "data": [
- {
- "id": "b808a463-a270-4276-93ce-f1e24e03ee15",
- "type": "mintmodel_history"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodels/9dd0466f-8a13-4ee8-a3b1-572d09e6c4ce",
- "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
}
}
]
}Generate a MintModel of the differences between two existing MintModels.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| old_mintmodel_id required | string Example: f8ec3641-b762-49b6-a79d-5e05aafce3ba old MintModel id |
| new_mintmodel_id required | string Example: 90f24894-aee2-4905-a4d3-980e9a696a60 new MintModel id |
{- "data": {
- "id": "MintModelDiff",
- "type": "diff_mintmodel",
- "attributes": {
- "diff_mintmodel": {
- "id": "74479947-4fa9-4cfd-908a-c938cddffcc8",
- "data": {
- "internalVariables": {
- "environmentName": "d1",
- "assetCode": "obpodi",
- "stageRootDir": "/oracle/stage",
- "autoBaseline": "true",
- "projectUri": "D1OBPODI2025MAY301254"
}, - "projectName": "d1_obpodi2025May30_1254",
- "site": {
- "hostList": [
- {
- "id": "custwprd1odi01",
- "address": "custwprd1odi01.limepoint.engineering",
- "attributes": {
- "basename": "custwprd1odi01",
- "user": "oracle",
- "password": "unused-key-auth",
- "targetTempDir": "/oracle/app/binaries/obpodi/tmp"
}, - "targetAttributes": {
- "oracle.install.username": "oinstall",
- "target.tmp.dir": "/oracle/app/binaries/obpodi/tmp"
}
}, - {
- "id": "db_server",
- "address": "custwprd1db.limepoint.engineering",
- "attributes": {
- "scaleout": "false",
- "basename": "custwprd1db",
- "user": "oracle",
- "password": "unused-key-auth",
- "targetTempDir": "/oracle/app/binaries/obpodi/tmp"
}, - "targetAttributes": {
- "oracle.install.username": "oinstall",
- "target.tmp.dir": "/oracle/app/binaries/obpodi/tmp"
}
}, - {
- "id": "custwprd1odi02",
- "address": "custwprd1odi02.limepoint.engineering",
- "attributes": {
- "basename": "custwprd1odi02",
- "user": "oracle",
- "password": "unused-key-auth",
- "targetTempDir": "/oracle/app/binaries/obpodi/tmp"
}, - "targetAttributes": {
- "oracle.install.username": "oinstall",
- "target.tmp.dir": "/oracle/app/binaries/obpodi/tmp"
}
}
], - "installationList": [
- {
- "name": "jdk",
- "product": "OracleJava",
- "version": "1.8.0_341",
- "installPath": "/oracle/app/binaries/obpodi/java",
- "softwareStage": "/oracle/stage/jdk/jdk-8u341-linux-x64.tar.gz",
- "attributes": {
- "newworld": "true",
- "oracleInventoryLoc": "/oracle/app/binaries/obpodi/oraInventory",
- "middlewareHome": "/oracle/app/binaries/obpodi/fmw",
- "oracleInstallGroup": "oinstall",
- "OracleJava": {
- "java_home": "/oracle/app/binaries/obpodi/java",
- "owner": "oracle",
- "group": "oinstall"
}
}, - "targetAttributes": {
- "patch.java.params": "-Xms3g -Xmx3g"
}, - "patchset": [ ]
}, - {
- "name": "fmwinfra",
- "product": "OracleFMWInfrastructure",
- "version": "12.2.1.4",
- "softwareStage": "/oracle/stage/fmwinfra/12.2.1.4/fmw_12.2.1.4.0_infrastructure.jar",
- "installPath": "/oracle/app/binaries/obpodi/fmw",
- "dependsonList": [
- "jdk"
], - "patchset": [
- {
- "targetOracleHome": "/oracle/app/binaries/obpodi/fmw/odi",
- "softwareStage": "/oracle/stage/cumulative_patches",
- "name": "3774133",
- "aru": "37741315",
- "attributes": {
- "required_opatch_version": "13.9.4.2.13",
- "opatch_autoupdate_file": "/oracle/stage/OPatch/13.9.4.2.10/p28186730_1394219_Generic.zip",
- "action": "rollback"
}
}
], - "attributes": {
- "newworld": "true",
- "middlewareHome": "/oracle/app/binaries/obpodi/fmw",
- "oracleInventoryLoc": "/oracle/app/binaries/obpodi/oraInventory",
- "oracleInstallGroup": "oinstall",
- "OracleFMWInfrastructure": {
- "inventory_location": "/oracle/app/binaries/obpodi/oraInventory",
- "fmw_home": "/oracle/app/binaries/obpodi/fmw",
- "owner": "oracle",
- "group": "oinstall"
}
}, - "targetAttributes": {
- "patch.java.params": "-Xms3g -Xmx3g"
}
}, - {
- "name": "oracleclient",
- "product": "OracleDatabaseClient",
- "version": "12.2.0.1",
- "installPath": "/oracle/app/binaries/obpodi/dbclient",
- "softwareStage": "/oracle/stage/rdbms/12.2.0.1/client",
- "dependsonList": [
- "jdk"
], - "attributes": {
- "newworld": "true",
- "oracleInventoryLoc": "/oracle/app/binaries/obpodi/oraInventory",
- "middlewareHome": "/oracle/app/binaries/obpodi/fmw",
- "oracleInstallGroup": "oinstall",
- "OracleDatabaseClient": {
- "inventory_location": "/oracle/app/binaries/obpodi/oraInventory",
- "owner": "oracle",
- "group": "oinstall",
- "oracle_home": "/oracle/app/binaries/obpodi/dbclient",
- "oracle_base": "/oracle/app/binaries/obpodi",
- "install_type": "Administrator"
}
}, - "targetAttributes": {
- "patch.java.params": "-Xms3g -Xmx3g"
}, - "patchset": [ ]
}, - {
- "name": "odi",
- "product": "OracleDataIntegrator",
- "version": "12.2.1.4",
- "installPath": "/oracle/app/binaries/obpodi/fmw/odi",
- "softwareStage": "/oracle/stage/odi/12.2.1.4/fmw_12.2.1.4.0_odi.jar",
- "dependsonList": [
- "fmwinfra",
- "oracleclient"
], - "patchset": [
- {
- "targetOracleHome": "/oracle/app/binaries/obpodi/fmw/odi",
- "softwareStage": "/oracle/stage/cumulative_patches",
- "name": "37741316",
- "aru": "37741315",
- "attributes": {
- "required_opatch_version": "13.9.4.2.13",
- "opatch_autoupdate_file": "/oracle/stage/OPatch/13.9.4.2.10/p28186730_1394219_Generic.zip",
- "action": "rollback"
}
}
], - "attributes": {
- "newworld": "true",
- "oracleInventoryLoc": "/oracle/app/binaries/obpodi/oraInventory",
- "middlewareHome": "/oracle/app/binaries/obpodi/fmw",
- "oracleInstallGroup": "oinstall",
- "OracleDataIntegrator": {
- "inventory_location": "/oracle/app/binaries/obpodi/oraInventory",
- "fmw_home": "/oracle/app/binaries/obpodi/fmw",
- "java_home": "/oracle/app/binaries/obpodi/java",
- "database_client_home": "/oracle/app/binaries/obpodi/dbclient",
- "owner": "oracle",
- "group": "oinstall"
}
}, - "targetAttributes": {
- "patch.java.params": "-Xms3g -Xmx3g"
}
}
], - "databaseList": [
- {
- "name": "d1obpodidb",
- "port": "1521",
- "serviceName": "CUSTWPD1_INT_PRIM",
- "hostIdentifier": "db_server",
- "schemaList": [
- {
- "name": "SYS",
- "password": "{AES2}TBg8KMlIiNzASfnaMO9iww=={/IV}ThoJT1+ps+2NtkzPjniGrRKwOu9f0fmuKS2GJPG0/LbU="
}
], - "attributes": {
- "jdbcUrl": "jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(Host=custwprd1db.limepoint.engineering)(Port=1521))(CONNECT_DATA=(SERVER = DEDICATED)(SERVICE_NAME=CUSTWPD1_INT_PRIM)))",
- "rcu": {
- "datafile.initialsize": "200M",
- "extra.parameters": " -encryptTablespace false"
}
}
}
], - "resourceList": [
- {
- "name": "WeblogicUser_wlsmonitors",
- "type": "User",
- "attributes": {
- "name": "wlsmonitor",
- "password": "{AES2}cSYn1SEsZCScuAK+fj8vVQ=={/IV}T89zXOBEdWngdxqJ9rihn+uy2lgiqJx5J6fGDfPbHsys=",
- "description": "User with Weblogic Monitor Role",
- "groupList": "monitors"
}
}, - {
- "name": "AdminStartupParameter",
- "type": "StartupParameter",
- "attributes": {
- "1": "-Xms1g -Xmx4g",
- "2": "",
- "3": "",
- "4": "-Dweblogic.ProductionModeEnabled=true",
- "5": "-Dappdynamics.agent.tierName=OBP-ADMIN",
- "c1": "-Dweblogic.Stdout=/oracle/app/logs/obpodi/obpodi_domain/%Name%/%Name%.out",
- "c2": "-Dweblogic.Stderr=/oracle/app/logs/obpodi/obpodi_domain/%Name%/%Name%.err",
- "c3": "-Xloggc:/oracle/app/logs/obpodi/obpodi_domain/%Name%/%Name%_gc.out -XX:+UseParNewGC -XX:+CMSParallelRemarkEnabled -XX:+UseConcMarkSweepGC -XX:+UseCMSInitiatingOccupancyOnly -XX:+ScavengeBeforeFullGC -XX:+CMSScavengeBeforeRemark -XX:CMSInitiatingOccupancyFraction=75 -XX:+UseGCLogFileRotation -XX:GCLogFileSize=300M -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCDateStamps -XX:+UnlockCommercialFeatures -XX:+FlightRecorder",
- "c4": "-Djava.security.debug=failure -Djava.net.preferIPv4Stack=true -Doracle.ons.maxconnections=2 -Dweblogic.security.disableNullCipher=true",
- "c5": "-Dweblogic.MaxMessageSize=500000000 -Dweblogic.Chunksize=65536 -Djava.security.egd=file:///dev/urandom",
- "s1": "-Dweblogic.security.SSL.minimumProtocolVersion=TLSv1.2 -Dweblogic.security.SSL.protocolVersion=TLSv1.2",
- "s2": "-Dweblogic.management.disableManagedServerNotifications=true",
- "s3": "-Dweblogic.security.SSL.allowUnencryptedNullCipher=false",
- "s4": "-Dweblogic.security.SSL.enableJSSE=true",
- "s4a": "-Dweblogic.security.SSL.nojce=true -Dweblogic.jdbc.remoteEnabled=true",
- "s5": "-Dweblogic.ssl.JSSEEnabled=true -Dweblogic.rjvm.enableprotocolswitch=true",
- "s6": "-Dweblogic.net.ssl.trustStore=/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "s7": "-Djavax.net.ssl.trustStore=/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "s8": "-Dweblogic.webservice.client.ssl.trustedcertfile=/oracle/app/runtime/d1/certs/cacerts.pem",
- "s9": "-Dweblogic.security.audit.auditLogDir=/oracle/app/logs/obpodi/obpodi_domain",
- "s10": "-Dweblogic.ssl.SSLv2HelloEnabled=false",
- "Auto22": "-Dweblogic.MuxerClass=weblogic.socket.PosixSocketMuxer"
}
}
], - "environmentName": "d1",
- "mwTopologyList": [
- {
- "attributes": {
- "targetPlatform": "x86-64"
}
}
], - "topologyName": "obpodi",
- "hostInstallationList": [
- {
- "installationName": "odi",
- "hostIdentifierList": [
- "custwprd1odi01",
- "custwprd1odi02"
]
}
], - "transferList": [
- {
- "name": "d1_obpodi_keystores",
- "hostIdentifierList": [
- "custwprd1odi01"
], - "sourceFile": "/oracle/stage/customer/wp/csh/certs/d1/custwprd1odi.jks",
- "destinationFile": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "permissions": "600",
- "transferWhenList": [
- "pre-online"
], - "attributes": {
- "scaleout": "false"
}
}
], - "executeList": [
- {
- "name": "DeployHealthCheck",
- "hostIdentifierList": [
- "custwprd1odi01"
], - "sourceFile": "/oracle/app/binaries/obpodi/fmw/oracle_common/common/bin/wlst.sh /oracle/stage/customer/wp/csh/scripts/common/deployApplication.py weblogic {AES2}gJ/boWTt1SiokXU8r5kR/w=={/IV}THBDYBplASG16qRhzfue+o4yOtJPAu4RCzOKq4C7V5Os= t3://custwprd1odi-padm.limepoint.engineering:17001 HealthCheck /oracle/app/runtime/obpodi/domains/applications/obpodi_domain/HealthCheck.war obpodi_cluster nostage 650",
- "executeWhenList": [
- "pre-online"
], - "attributes": {
- "execute.weblogicAdminPassword": "{AES2}gJ/boWTt1SiokXU8r5kR/w=={/IV}THBDYBplASG16qRhzfue+o4yOtJPAu4RCzOKq4C7V5Os=",
- "scaleout": "false"
}
}
], - "domainList": [
- {
- "name": "obpodi_domain",
- "locationPath": "/oracle/app/runtime/obpodi/domains",
- "adminUser": "weblogic",
- "adminPassword": "{AES2}gJ/boWTt1SiokXU8r5kR/w=={/IV}THBDYBplASG16qRhzfue+o4yOtJPAu4RCzOKq4C7V5Os=",
- "adminServer": {
- "name": "AdminServer",
- "machineName": "custwprd1odi01-prv.limepoint.engineering",
- "listenAddress": "custwprd1odi-padm.limepoint.engineering",
- "listenAddressPort": "17001",
- "listenAddressPortSSL": "18001",
- "targetName": "odiAdminServer"
}, - "machineList": [
- {
- "name": "custwprd1odi01-prv.limepoint.engineering",
- "nodeManagerName": "nm-custwprd1odi01"
}, - {
- "name": "custwprd1odi02-prv.limepoint.engineering",
- "nodeManagerName": "nm-custwprd1odi02"
}
], - "clusterList": [
- {
- "name": "obpodi_cluster",
- "messageMode": "Unicast"
}
], - "managedServerList": [
- {
- "name": "ODI_server1",
- "machineName": "custwprd1odi01-prv.limepoint.engineering",
- "clusterName": "obpodi_cluster",
- "listenAddress": "custwprd1odi01-prv.limepoint.engineering",
- "listenAddressPort": "17002",
- "listenAddressPortSSL": "18002",
- "targetName": "ODI_server1",
- "attributes": {
- "nodeid": "1",
- "serverid": "1",
- "nodeonserver": "1"
}
}, - {
- "name": "ODI_server2",
- "machineName": "custwprd1odi02-prv.limepoint.engineering",
- "clusterName": "obpodi_cluster",
- "listenAddress": "custwprd1odi02-prv.limepoint.engineering",
- "listenAddressPort": "17003",
- "listenAddressPortSSL": "18003",
- "targetName": "ODI_server2",
- "attributes": {
- "nodeid": "2",
- "serverid": "2",
- "nodeonserver": "1"
}
}
], - "systemComponentList": [
- {
- "name": "OracleDISAgent1",
- "machineName": "custwprd1odi01-prv.limepoint.engineering",
- "componentType": "OracleDataIntegrator",
- "attributes": {
- "nodeid": "1",
- "serverid": "1",
- "nodeonserver": "1",
- "OracleDataIntegrator": {
- "SupervisorPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "AgentProtocol": "https",
- "AgentHostname": "custwprd1odi01-prv.limepoint.engineering",
- "AgentPort": "2091",
- "PrivateKeyAlias": "custwprd1odi01",
- "PrivateKeyPassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "IdentityKeyStore": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "IdentityKeyStorePassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "TrustKeyStore": "/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "TrustKeyStorePassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk="
}
}
}, - {
- "name": "OracleDISAgent2",
- "machineName": "custwprd1odi02-prv.limepoint.engineering",
- "componentType": "OracleDataIntegrator",
- "attributes": {
- "nodeid": "2",
- "serverid": "2",
- "nodeonserver": "1",
- "OracleDataIntegrator": {
- "SupervisorPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "AgentProtocol": "https",
- "AgentHostname": "custwprd1odi02-prv.limepoint.engineering",
- "AgentPort": "2091",
- "PrivateKeyAlias": "custwprd1odi02",
- "PrivateKeyPassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "IdentityKeyStore": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "IdentityKeyStorePassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "TrustKeyStore": "/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "TrustKeyStorePassPhrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk="
}
}
}
], - "middlewareList": [
- {
- "installationName": "odi",
- "targetList": [
- {
- "type": "Cluster",
- "names": [
- "obpodi_cluster"
]
}
]
}
], - "configurationList": [
- {
- "resourceName": "AdminStartupParameter",
- "type": "StartupParameter",
- "targets": [
- {
- "type": "SERVER",
- "names": [
- "AdminServer"
]
}
]
}, - {
- "resourceName": "WeblogicUser_wlsmonitors",
- "type": "User",
- "attributes": {
- "authenticatorName": "DefaultAuthenticator"
}
}
], - "templateList": [
- {
- "name": "OracleDataIntegrator::CombinedTemplateSet",
- "attributes": {
- "OracleDataIntegrator::CombinedTemplateSet": {
- "SupervisorPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "WorkRepositoryName": "workrep1",
- "WorkRepositoryPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "WorkRepositoryType": "E",
- "AgentHostname": "custwpd1odi.limepoint.engineering",
- "AgentPort": "18002",
- "AgentProtocol": "https"
}
}
}
], - "repositoryList": [
- {
- "componentList": [
- "ODI"
], - "id": "rcu01",
- "dbName": "d1obpodidb",
- "prefix": "OBPODI",
- "dbUser": "SYS",
- "schemaPassword": "{AES2}jsLtJusUxDWQfC6Mq+UwHg=={/IV}TuT5JIopcfHbGjkEt7xUhoQ==",
- "defaultRepository": "true"
}
], - "attributes": {
- "serverStartMode": "prod",
- "backupEnvironmentName": "d1",
- "environment.name": "d1",
- "tlogsLocationPath": "/oracle/app/runtime/obpodi/domains/obpodi_domain",
- "odlLogLocation": "/oracle/app/logs/obpodi/obpodi_domain",
- "defaultJMSLogLocation": "/oracle/app/logs/obpodi/obpodi_domain",
- "managedTopLocation": "/oracle/app/binaries/runtime/obpodi/domains",
- "nodeid": "1",
- "nodeonserver": "1",
- "serverid": "1",
- "wls": {
- "production.mode": "prod",
- "tlogs.location.path": "/oracle/app/runtime/obpodi/domains/obpodi_domain",
- "admin.listen.port.admin": "19001",
- "domain.managed.top": "/oracle/app/binaries/runtime/obpodi/domains",
- "odl": {
- "log": {
- "location": "/oracle/app/logs/obpodi/obpodi_domain",
- "retentionPeriod": "5d"
}
}
}, - "mintpress": {
- "startup.server_exclude": "OracleDISAgent*",
- "startup_parallel": "10"
}
}
}
], - "nodeManagerList": [
- {
- "name": "nm-custwprd1odi01",
- "listenAddress": "custwprd1odi01-prv.limepoint.engineering",
- "listenPort": "16001",
- "hostIdentifier": "custwprd1odi01",
- "attributes": {
- "wlInstallationName": "fmwinfra",
- "nodemanagerTop": "/oracle/app/binaries/runtime/obpodi/domains/obpodi_domain/nodemanager",
- "type": "SSL",
- "wls": {
- "nodemanager": {
- "log.path": "/oracle/app/logs/obpodi/custwprd1odi01",
- "identityname": "custwprd1odi01",
- "identitystorefile": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "wildcardcertificate": "true",
- "domainbased": "true",
- "shared.domain.dir": "true",
- "top": "/oracle/app/binaries/runtime/obpodi/domains/obpodi_domain/nodemanager"
}
}
}, - "targetAttributes": {
- "wls": {
- "nodemanager": {
- "secure.listener": "true",
- "setidentity": "true",
- "usejsse": "true",
- "crashrecovery": "false",
- "umask": "022",
- "truststorefile": "/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "identitystorekey": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "truststorekey": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "identitypassphrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk="
}
}
}
}, - {
- "name": "nm-custwprd1odi02",
- "listenAddress": "custwprd1odi02-prv.limepoint.engineering",
- "listenPort": "16001",
- "hostIdentifier": "custwprd1odi02",
- "attributes": {
- "wlInstallationName": "fmwinfra",
- "nodemanagerTop": "/oracle/app/binaries/runtime/obpodi/domains/obpodi_domain/nodemanager",
- "type": "SSL",
- "wls": {
- "nodemanager": {
- "log.path": "/oracle/app/logs/obpodi/custwprd1odi02",
- "identityname": "custwprd1odi02",
- "identitystorefile": "/oracle/app/runtime/d1/certs/custwprd1odi.jks",
- "wildcardcertificate": "true",
- "domainbased": "true",
- "shared.domain.dir": "true",
- "top": "/oracle/app/binaries/runtime/obpodi/domains/obpodi_domain/nodemanager"
}
}
}, - "targetAttributes": {
- "wls": {
- "nodemanager": {
- "secure.listener": "true",
- "setidentity": "true",
- "usejsse": "true",
- "crashrecovery": "false",
- "umask": "022",
- "truststorefile": "/oracle/app/runtime/d1/certs/WBCTrust.jks",
- "identitystorekey": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "truststorekey": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk=",
- "identitypassphrase": "{AES2}h2PRZ4Y+dzJGqQaewXAXBQ=={/IV}TtSlVPbhcKefdwYVrR0caCgwsTQGc57f3ofH8B47O9yk="
}
}
}
}
]
}
}, - "sha256": "901ad813694fa591bd0c6c9ec172f1d97e35daaa14c1c9010cbef45f44338483",
- "created_at": "2026-02-23T07:58:02.879Z",
- "updated_at": "2026-02-23T07:58:02.879Z",
- "render_logs": "Generated by deriving the difference between Mintmodel 084335a4-6e3a-46f7-a0da-0b76c9bddd5e and MintModel 78321fac-94f7-4b61-8b04-68cf39aa54f5"
}, - "step_trees": [
- {
- "name": "Binaries",
- "action": "mintmodel:binaries",
- "description": "bpm -- Binaries",
- "child_execution_strategy": "sequential",
- "children": [
- {
- "name": "Install Software Binaries",
- "action": "mintmodel:install_software_binaries",
- "description": null,
- "full_path": "Binaries/Install Software Binaries",
- "full_description": "bpm -- Binaries > Install Software Binaries"
}
], - "full_path": "Binaries",
- "full_description": "bpm -- Binaries"
}
]
}, - "links": {
- "old_mintmodel": "/projects/opc/assets/prj_soa/mintmodels/084335a4-6e3a-46f7-a0da-0b76c9bddd5e",
- "new_mintmodel": "/projects/opc/assets/prj_soa/mintmodels/78321fac-94f7-4b61-8b04-68cf39aa54f5",
- "parent": "/projects/opc/assets/prj_soa"
}
}
}Shows an asset MintModel.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
| mintmodel_id required | string Example: 83876850-520c-4847-a7ef-dfa3eaae2a30 MintModel id |
{- "data": {
- "id": "9ea6c000-bcf3-49e6-b601-11a4465501c6",
- "type": "mintmodel",
- "attributes": {
- "data": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
- "created_at": "2026-02-23T07:58:03.294922Z",
- "updated_at": "2026-02-23T07:58:03.294922Z",
- "render_logs": "[\"MintPress renderer output\"]"
}, - "relationships": {
- "mintmodel_history": {
- "data": [
- {
- "id": "89ea6a1d-f695-4bc5-9c45-633562f0341f",
- "type": "mintmodel_history"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodels/9ea6c000-bcf3-49e6-b601-11a4465501c6",
- "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
}
}
}Generate the MintModel for this asset, using the latest properties and template version.
Note: The endpoint does not store the MintModel, rather it provides a point in time reference for the MintModel content that will be used by a change if one is executed for the asset.
| project_code required | string Example: opc project code |
| asset_code required | string Example: prj_soa asset code |
{- "data": {
- "id": "48a2a6f1-1c86-469e-8f1a-fb59f6ea7d38",
- "type": "mintmodel",
- "attributes": {
- "data": {
- "complex": {
- "json": {
- "mintmodel": "data"
}
}
}, - "sha256": "77526a9ef926aee8c98f90ec845f5bd12f58cd7afb29fb2db5ef8f95deec44f8",
- "created_at": "2026-02-23T07:58:03.729117Z",
- "updated_at": "2026-02-23T07:58:03.729117Z",
- "render_logs": "[\"MintPress renderer output\"]"
}, - "relationships": {
- "mintmodel_history": {
- "data": [
- {
- "id": "cd44e9b5-2cf1-45d1-acfe-bf1fd1ea88d2",
- "type": "mintmodel_history"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/assets/prj_soa/mintmodels/48a2a6f1-1c86-469e-8f1a-fb59f6ea7d38",
- "parent_mintmodel_history": "/api/projects/opc/assets/prj_soa/mintmodel_history"
}
}
}Lists all workflows for a project.
| project_code required | string Example: opc project code |
{- "data": [
- {
- "id": "8a2eae1f-13ac-41c7-a1d7-8d075aff10c8",
- "type": "workflow",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "miquel",
- "created_at": "2026-02-23T07:59:24.385063Z",
- "updated_at": "2026-02-23T07:59:24.385063Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "latest_version": 2,
- "notifications": { },
- "latest_published_version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "f081de7b-ac14-4a44-907b-8cc0b3c83d78",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "6a3f4f1f-93dd-46c4-939d-a97787d7e41f",
- "type": "workflow_version"
}, - {
- "id": "5f476c55-1d3e-41d7-895a-be3a8555502b",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets",
- "runs": "/api/projects/opc/workflows/assets/runs",
- "versions": "/api/projects/opc/workflows/assets/versions",
- "latest_version": "/api/projects/opc/workflows/assets/versions/2",
- "latest_published_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Create a workflow
| project_code required | string Example: opc project code |
required | object |
object |
{- "data": {
- "attributes": {
- "code": "o5mmv",
- "archived": false,
- "name": "f0kdeewvro",
- "description": "The SQL monitor is down, copy the primary card so we can hack the SAS firewall!",
- "notifications": { },
- "steps": [
- {
- "type": "change",
- "targets": [
- "/projects/bzfco/environments/gnbxl/assets/fzyye",
- "/projects/7j9tb/environments/imzan/assets/oxaks"
], - "action": "parse",
- "template_versions": [
- "2yoiy",
- "l0e28"
], - "run_as": "parallel",
- "name": "iusto"
}, - {
- "type": "wait",
- "name": "non"
}, - {
- "type": "workflow",
- "target": "/projects/ddj2b/workflows/0rbp3",
- "version": 1,
- "name": "culpa",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "run_as": "parallel",
- "name": "accusamus",
- "children": [
- {
- "type": "change",
- "target": "/projects/ir22q/environments/oj8rh/assets/pfdp7",
- "action": "navigate",
- "template_version": "brain",
- "name": "sequi",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "type": "wait",
- "name": "impedit"
}, - {
- "type": "workflow",
- "target": "/projects/je6dw/workflows/aw2rz",
- "version": 1,
- "name": "molestiae",
- "start_time": "2026-02-24T07:57:35Z"
}
]
}, - {
- "run_as": "sequential",
- "name": "vel",
- "children": [
- {
- "type": "change",
- "target": "/projects/vodvu/environments/f06se/assets/wpvzp",
- "action": "input",
- "template_version": "1oum6",
- "name": "consequatur",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "type": "wait",
- "name": "ea"
}, - {
- "type": "workflow",
- "target": "/projects/bo3pj/workflows/huyka",
- "version": null,
- "name": "esse",
- "start_time": "2026-02-24T07:57:35Z"
}
]
}
], - "draft": true
}
}
}{- "data": {
- "id": "19610f16-a546-4425-9fba-527141865951",
- "type": "workflow",
- "attributes": {
- "code": "assets_new",
- "name": "assets workflow_new",
- "description": null,
- "draft": false,
- "archived": false,
- "created_by": "grant",
- "created_at": "2026-02-23T07:59:24.908036Z",
- "updated_at": "2026-02-23T07:59:24.908036Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": { },
- "latest_version": 1,
- "notifications": { },
- "latest_published_version": 1
}, - "relationships": {
- "parent": {
- "data": {
- "id": "eddbc24e-e44c-4d81-9e71-6afec563c655",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "aad1b84d-4827-434b-b7a4-2ab7938a8553",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets_new",
- "runs": "/api/projects/opc/workflows/assets_new/runs",
- "versions": "/api/projects/opc/workflows/assets_new/versions",
- "latest_version": "/api/projects/opc/workflows/assets_new/versions/1",
- "latest_published_version": "/api/projects/opc/workflows/assets_new/versions/1"
}
}
}Shows a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "data": {
- "id": "fa6088e1-9423-429a-b6eb-5c042dba96b7",
- "type": "workflow",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "darin",
- "created_at": "2026-02-23T07:59:25.634326Z",
- "updated_at": "2026-02-23T07:59:25.634326Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "latest_version": 2,
- "notifications": { },
- "latest_published_version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "b5751ba5-0624-4dd7-90f5-739da2734998",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "4d62992d-5be7-4da7-ac5c-7d511ecdcb26",
- "type": "workflow_version"
}, - {
- "id": "4086055a-ff8a-4a32-989b-5bff987dc516",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets",
- "runs": "/api/projects/opc/workflows/assets/runs",
- "versions": "/api/projects/opc/workflows/assets/versions",
- "latest_version": "/api/projects/opc/workflows/assets/versions/2",
- "latest_published_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
}Update a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
required | object |
{- "data": {
- "attributes": {
- "archived": false,
- "name": "xlyittiypl",
- "description": "We need to synthesize the haptic THX interface!",
- "notifications": { },
- "steps": [
- {
- "type": "change",
- "targets": [
- "/projects/bzfco/environments/gnbxl/assets/fzyye",
- "/projects/7j9tb/environments/imzan/assets/oxaks"
], - "action": "parse",
- "template_versions": [
- "2yoiy",
- "l0e28"
], - "run_as": "parallel",
- "name": "iusto"
}, - {
- "type": "wait",
- "name": "non"
}, - {
- "type": "workflow",
- "target": "/projects/ddj2b/workflows/0rbp3",
- "version": 1,
- "name": "culpa",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "run_as": "parallel",
- "name": "accusamus",
- "children": [
- {
- "type": "change",
- "target": "/projects/ir22q/environments/oj8rh/assets/pfdp7",
- "action": "navigate",
- "template_version": "brain",
- "name": "sequi",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "type": "wait",
- "name": "impedit"
}, - {
- "type": "workflow",
- "target": "/projects/je6dw/workflows/aw2rz",
- "version": 1,
- "name": "molestiae",
- "start_time": "2026-02-24T07:57:35Z"
}
]
}, - {
- "run_as": "sequential",
- "name": "vel",
- "children": [
- {
- "type": "change",
- "target": "/projects/vodvu/environments/f06se/assets/wpvzp",
- "action": "input",
- "template_version": "1oum6",
- "name": "consequatur",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "type": "wait",
- "name": "ea"
}, - {
- "type": "workflow",
- "target": "/projects/bo3pj/workflows/huyka",
- "version": null,
- "name": "esse",
- "start_time": "2026-02-24T07:57:35Z"
}
]
}
], - "draft": true
}
}
}{- "data": {
- "id": "45f0adbb-485b-4684-8d40-b08f3d4457be",
- "type": "workflow",
- "attributes": {
- "code": "assets",
- "name": "new workflow name",
- "description": "new description",
- "draft": false,
- "archived": false,
- "created_by": "clifton",
- "created_at": "2026-02-23T07:59:26.229852Z",
- "updated_at": "2026-02-23T07:59:26.311618Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa",
- "source": "steps/1",
- "change_parent": {
- "id": "7379de0d-9c68-4473-a89e-6dc8416050da",
- "path": "/projects/opc/assets/prj_soa",
- "parent_path": "/projects/opc",
- "project_id": "f6822c6b-5e74-4391-ae4c-94a9e2ddf7e8",
- "node_type": "asset",
- "parent_id": "f6822c6b-5e74-4391-ae4c-94a9e2ddf7e8",
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_at": "2026-02-23T07:59:26.166Z",
- "updated_at": "2026-02-23T07:59:26.166Z",
- "project_type": null,
- "template_version_id": "582555bd-26dc-47b9-910d-a79845ca8d9a",
- "created_by": "otto_wehner"
}, - "action_template_version": {
- "id": "582555bd-26dc-47b9-910d-a79845ca8d9a",
- "commit_id": "5daed25c-ff6e-47a5-87aa-b0ebb385b9c3",
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "created_at": "2026-02-23T07:59:26.150Z",
- "updated_at": "2026-02-23T07:59:26.150Z",
- "state": "ready",
- "created_by": "rey_quigley",
- "archived": false,
- "has_mintmodel": true,
- "template_id": "5aa381af-f64a-4d8a-8414-02c7acea60e7",
- "locked": false
}
}
], - "sample_properties": {
- "sample": "value"
}, - "latest_version": 2,
- "notifications": { },
- "latest_published_version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "f6822c6b-5e74-4391-ae4c-94a9e2ddf7e8",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "ba0474d5-ab96-4213-babe-13575f3e8ace",
- "type": "workflow_version"
}, - {
- "id": "9e4ce42f-54bc-4841-b2f4-45b1842d43b0",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets",
- "runs": "/api/projects/opc/workflows/assets/runs",
- "versions": "/api/projects/opc/workflows/assets/versions",
- "latest_version": "/api/projects/opc/workflows/assets/versions/2",
- "latest_published_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
}Delete or archive a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find Workflow"
}
}
]
}Lists all versions for a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "data": [
- {
- "id": "f26726e1-65ee-4c1b-ae85-fc607d8e1014",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "rolando_greenholt",
- "created_at": "2026-02-23T07:59:20.295571Z",
- "updated_at": "2026-02-23T07:59:20.305282Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "6f20cdf3-3352-448b-84fd-28b6b2a4c005",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "6c2bdbf1-7ef6-4f25-a362-462d1feaaab1",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "xuan.johns",
- "created_at": "2026-02-23T07:59:20.274241Z",
- "updated_at": "2026-02-23T07:59:20.274258Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "version": 1
}, - "relationships": {
- "parent": {
- "data": {
- "id": "6f20cdf3-3352-448b-84fd-28b6b2a4c005",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/1",
- "runs": "/api/projects/opc/workflows/assets/versions/1/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Deletes all draft versions of a workflow.
Note: At least one version will remain. If all versions are drafts, the latest draft version will be kept.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "data": {
- "id": "c7c6cde7-57c1-416e-85c0-eb71af4e18a6",
- "type": "workflow",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "myron_smith",
- "created_at": "2026-02-23T07:59:21.005521Z",
- "updated_at": "2026-02-23T07:59:21.005521Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "latest_version": 2,
- "notifications": { },
- "latest_published_version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "76563a63-8c16-42c6-b279-269213aacd7e",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "versions": {
- "data": [
- {
- "id": "3b9fe3b7-d43b-4878-aace-f72eeb489747",
- "type": "workflow_version"
}, - {
- "id": "7c1e5155-ad32-43a9-82a9-a4ce1448c95e",
- "type": "workflow_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets",
- "runs": "/api/projects/opc/workflows/assets/runs",
- "versions": "/api/projects/opc/workflows/assets/versions",
- "latest_version": "/api/projects/opc/workflows/assets/versions/2",
- "latest_published_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
}Shows a workflow version.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| version required | string Example: 2 version |
{- "data": {
- "id": "343d6964-3d18-456d-9fff-4223bbd93c7a",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "tammara",
- "created_at": "2026-02-23T07:59:21.541051Z",
- "updated_at": "2026-02-23T07:59:21.551309Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "d97fcf4d-63ae-49f0-b37a-3ecaabde7c69",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
}Update a workflow version.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| version required | string Example: 2 version |
required | object |
object |
{- "data": {
- "attributes": {
- "code": "b4avr",
- "node_id": "33b1241b-f861-4f5f-9bed-ebb999ae46b4",
- "archived": false,
- "name": "ww5ftwiyky",
- "description": "Use the multi-byte SSL feed, then you can synthesize the bluetooth application!",
- "notifications": { },
- "steps": [
- {
- "type": "change",
- "targets": [
- "/projects/bzfco/environments/gnbxl/assets/fzyye",
- "/projects/7j9tb/environments/imzan/assets/oxaks"
], - "action": "parse",
- "template_versions": [
- "2yoiy",
- "l0e28"
], - "run_as": "parallel",
- "name": "iusto"
}, - {
- "type": "wait",
- "name": "non"
}, - {
- "type": "workflow",
- "target": "/projects/ddj2b/workflows/0rbp3",
- "version": 1,
- "name": "culpa",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "run_as": "parallel",
- "name": "accusamus",
- "children": [
- {
- "type": "change",
- "target": "/projects/ir22q/environments/oj8rh/assets/pfdp7",
- "action": "navigate",
- "template_version": "brain",
- "name": "sequi",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "type": "wait",
- "name": "impedit"
}, - {
- "type": "workflow",
- "target": "/projects/je6dw/workflows/aw2rz",
- "version": 1,
- "name": "molestiae",
- "start_time": "2026-02-24T07:57:35Z"
}
]
}, - {
- "run_as": "sequential",
- "name": "vel",
- "children": [
- {
- "type": "change",
- "target": "/projects/vodvu/environments/f06se/assets/wpvzp",
- "action": "input",
- "template_version": "1oum6",
- "name": "consequatur",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "type": "wait",
- "name": "ea"
}, - {
- "type": "workflow",
- "target": "/projects/bo3pj/workflows/huyka",
- "version": null,
- "name": "esse",
- "start_time": "2026-02-24T07:57:35Z"
}
]
}
], - "draft": true
}
}
}{- "data": {
- "id": "062a9eee-edad-4f0c-aca2-7a4962edfbdb",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "new workflow name",
- "description": "new description",
- "draft": true,
- "archived": false,
- "created_by": "joaquin_wyman",
- "created_at": "2026-02-23T07:59:22.825679Z",
- "updated_at": "2026-02-23T07:59:22.901861Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "type": "change",
- "targets": [
- "/projects/bzfco/environments/gnbxl/assets/fzyye",
- "/projects/7j9tb/environments/imzan/assets/oxaks"
], - "action": "parse",
- "template_versions": [
- "2yoiy",
- "l0e28"
], - "run_as": "parallel",
- "name": "iusto"
}, - {
- "type": "wait",
- "name": "non"
}, - {
- "type": "workflow",
- "target": "/projects/ddj2b/workflows/0rbp3",
- "version": 1,
- "name": "culpa",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "run_as": "parallel",
- "name": "accusamus",
- "children": [
- {
- "type": "change",
- "target": "/projects/ir22q/environments/oj8rh/assets/pfdp7",
- "action": "navigate",
- "template_version": "brain",
- "name": "sequi",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "type": "wait",
- "name": "impedit"
}, - {
- "type": "workflow",
- "target": "/projects/je6dw/workflows/aw2rz",
- "version": 1,
- "name": "molestiae",
- "start_time": "2026-02-24T07:57:35Z"
}
]
}, - {
- "run_as": "sequential",
- "name": "vel",
- "children": [
- {
- "type": "change",
- "target": "/projects/vodvu/environments/f06se/assets/wpvzp",
- "action": "input",
- "template_version": "1oum6",
- "name": "consequatur",
- "start_time": "2026-02-24T07:57:35Z"
}, - {
- "type": "wait",
- "name": "ea"
}, - {
- "type": "workflow",
- "target": "/projects/bo3pj/workflows/huyka",
- "version": null,
- "name": "esse",
- "start_time": "2026-02-24T07:57:35Z"
}
]
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "e90e2e6a-9eea-4a39-b8a1-9b6036738304",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
}Delete or archive a workflow version.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| version required | string Example: 2 version |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find WorkflowVersion"
}
}
]
}Endpoints to interact with properties.
Shows the current properties JSON and its version.
| properties_id required | string Example: b37f93b1-41f9-498a-8341-160a785642b8 properties id |
{- "data": {
- "id": "e801b7ca-47e7-441c-98f6-87bb0cec9761",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-02-23T07:58:18.144487Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/properties/e801b7ca-47e7-441c-98f6-87bb0cec9761",
- "current_version": "/api/properties/e801b7ca-47e7-441c-98f6-87bb0cec9761/versions/1",
- "versions": "/api/properties/e801b7ca-47e7-441c-98f6-87bb0cec9761/versions"
}
}
}Updates a properties JSON if the included version matches the current properties version.
| id_to_update required | string Example: b37f93b1-41f9-498a-8341-160a785642b8 properties id |
required | object |
{- "data": {
- "attributes": {
- "data": {
- "any_key": "with updated value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1
}
}
}{- "data": {
- "id": "c515d05c-59f8-420a-a23c-db94fea31b2f",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with updated value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 2,
- "created_at": "2026-02-23T07:58:18.417717Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/properties/c515d05c-59f8-420a-a23c-db94fea31b2f",
- "current_version": "/api/properties/c515d05c-59f8-420a-a23c-db94fea31b2f/versions/2",
- "versions": "/api/properties/c515d05c-59f8-420a-a23c-db94fea31b2f/versions"
}
}
}Updates a properties JSON, without any version checking (always updates).
| id_to_set required | string Example: b37f93b1-41f9-498a-8341-160a785642b8 properties id |
required | object |
{- "data": {
- "attributes": {
- "data": {
- "any_key": "with updated value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}
}
}{- "data": {
- "id": "8258291d-60d1-4148-895c-ba1784970f7a",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with updated value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 2,
- "created_at": "2026-02-23T07:58:18.929135Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/properties/8258291d-60d1-4148-895c-ba1784970f7a",
- "current_version": "/api/properties/8258291d-60d1-4148-895c-ba1784970f7a/versions/2",
- "versions": "/api/properties/8258291d-60d1-4148-895c-ba1784970f7a/versions"
}
}
}Update a file property in the properties.
| properties_id required | string Example: b37f93b1-41f9-498a-8341-160a785642b8 properties id |
| file_path | string (Path to write the file within /opt/opschain) |
| mode | string (Linux octal file mode) |
| format | string (Valid values are 'raw' (default), 'json' or 'base64') |
| replace_file | string (Replace the file property if it exists (default: false)) |
| secret_path | string (Path to write the secret key into) |
| secret_key | string |
| replace_secret | string (Replace the secret vault value if it exists (default: false)) |
| file | string <binary> File to use. The filename is ignored. |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="mode" 0600 ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file_path" /opt/opschain/sample.txt ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="format" raw ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="replace_file" true ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file"; filename="sample.txt" content-type: text/plain content-length: 21 Sample file property ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "fba97e5a-6a5d-411f-bc4d-21250e10053d",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}, - "opschain": {
- "files": {
- "/opt/opschain/sample.txt": {
- "mode": "0600",
- "format": "raw",
- "content": "Sample file property\n"
}
}
}
}, - "version": 2,
- "created_at": "2026-02-23T07:58:19.388093Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/properties/fba97e5a-6a5d-411f-bc4d-21250e10053d",
- "current_version": "/api/properties/fba97e5a-6a5d-411f-bc4d-21250e10053d/versions/2",
- "versions": "/api/properties/fba97e5a-6a5d-411f-bc4d-21250e10053d/versions"
}
}
}Endpoints to interact with the version history for properties.
Lists all versions of an OpsChain properties.
| properties_id required | string Example: b37f93b1-41f9-498a-8341-160a785642b8 properties id |
{- "data": [
- {
- "id": "5d0ad960-80eb-416d-8b9f-35e453f3d26e",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-02-23T07:58:19.577679Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "620557ff-c0e3-4dee-b6d0-736c9ca43109",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/620557ff-c0e3-4dee-b6d0-736c9ca43109"
}
}
}, - "links": {
- "versions": "/api/properties/620557ff-c0e3-4dee-b6d0-736c9ca43109/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/620557ff-c0e3-4dee-b6d0-736c9ca43109/versions/1"
}, - "meta": { }
}
]
}Shows the properties JSON for this properties version.
| properties_id required | string Example: b37f93b1-41f9-498a-8341-160a785642b8 properties id |
| version_number required | integer Example: 1 version number |
{- "data": {
- "id": "67806185-24fb-4cf0-8a7d-ed6cb91de795",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-02-23T07:58:19.833130Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "733296ef-5672-4f5b-a9ac-cd5c863d4391",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/733296ef-5672-4f5b-a9ac-cd5c863d4391"
}
}
}, - "links": {
- "versions": "/api/properties/733296ef-5672-4f5b-a9ac-cd5c863d4391/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/733296ef-5672-4f5b-a9ac-cd5c863d4391/versions/1"
}, - "meta": { }
}
}Endpoints to interact with changes.
Lists all changes.
| filter[<query/sort filter>]= | |
| download | string Example: download=changes.csv Download changes in CSV format with the specified file name. The changes will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
| include | string Example: include=steps,parents Include the change steps and parents in the response |
{- "data": [
- {
- "id": "17b32c72-fb64-4a47-8cf1-4facf0cb3cf0",
- "type": "change",
- "attributes": {
- "created_by": "genaro.cartwright",
- "name": "parse",
- "action": "parse",
- "build_without_cache": false,
- "initial_step_tree": { },
- "metadata": {
- "panel": "programming"
}, - "scheduled": false,
- "approved_by": [ ],
- "rejected_by": [ ],
- "cancelled_by": null,
- "status_code": "success",
- "mintmodel_change": false,
- "created_at": "2026-02-23T07:57:53.454713Z",
- "started_at": "2026-02-23T07:51:19.227788Z",
- "finished_at": "2026-02-23T07:53:42.498408Z",
- "updated_at": "2026-02-23T07:57:53.463502Z",
- "asset_name": null,
- "environment_name": "Development",
- "project_name": "OpsChain",
- "git_remote_name": "github",
- "git_rev": "main",
- "commit_sha": "2f3880c2f5a2e7a24e7d80b7aaa4e46924a4e19d",
- "requires_approval_from": null
}, - "relationships": {
- "properties": {
- "data": {
- "id": "11c3b162-f6c9-469c-bf18-17b343d77652",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/11c3b162-f6c9-469c-bf18-17b343d77652"
}
}, - "parents": {
- "data": [
- {
- "id": "61bf1fae-7c57-4269-9909-bb903d24fd7a",
- "type": "project"
}, - {
- "id": "ba218162-d019-4617-aa1c-f21afa4922fe",
- "type": "environment"
}
]
}, - "root_step": {
- "data": {
- "id": "1811de99-5c12-42b0-acea-85afc2411116",
- "type": "step"
}, - "links": {
- "related": "/api/steps/1811de99-5c12-42b0-acea-85afc2411116"
}
}, - "steps": {
- "data": [
- {
- "id": "1811de99-5c12-42b0-acea-85afc2411116",
- "type": "step"
}
]
}, - "workflow_run": {
- "data": null
}, - "workflow": {
- "data": null
}, - "override_properties": {
- "data": {
- "id": "3e619332-24cf-4dde-bca6-e309c821a968",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/3e619332-24cf-4dde-bca6-e309c821a968"
}
}, - "override_settings": {
- "data": {
- "id": "5f568886-0341-4c12-9a84-66a2e2f2f5b9",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/5f568886-0341-4c12-9a84-66a2e2f2f5b9"
}
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/f1c4b91c-0c9c-4f54-9482-164b701a0783",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/projects/opc/environments/dev/changes/17b32c72-fb64-4a47-8cf1-4facf0cb3cf0",
- "log_lines": "/api/changes/17b32c72-fb64-4a47-8cf1-4facf0cb3cf0/log_lines"
}, - "meta": { }
}
], - "included": [
- {
- "id": "1811de99-5c12-42b0-acea-85afc2411116",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "action": "parse",
- "name": "parse",
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "17b32c72-fb64-4a47-8cf1-4facf0cb3cf0",
- "skip_on_retry": false,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:50:19.227788Z",
- "started_at": "2026-02-23T07:51:19.227788Z",
- "finished_at": "2026-02-23T07:53:42.498408Z",
- "updated_at": "2026-02-23T07:57:53.463502Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "11c3b162-f6c9-469c-bf18-17b343d77652",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/11c3b162-f6c9-469c-bf18-17b343d77652"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "acc42ca7-a283-4960-ab7a-09cd1c81135f",
- "type": "properties_version"
}, - {
- "id": "2199b88f-fdc3-4a7e-b6c3-be99169f9d96",
- "type": "properties_version"
}, - {
- "id": "b7547a9d-b44e-4a53-a408-031ad114a7b8",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "17b32c72-fb64-4a47-8cf1-4facf0cb3cf0",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/17b32c72-fb64-4a47-8cf1-4facf0cb3cf0",
- "change": "/api/projects/opc/environments/dev/changes/17b32c72-fb64-4a47-8cf1-4facf0cb3cf0",
- "log_lines": "/api/steps/1811de99-5c12-42b0-acea-85afc2411116/log_lines",
- "self": "/api/steps/1811de99-5c12-42b0-acea-85afc2411116"
}, - "meta": { }
}, - {
- "id": "61bf1fae-7c57-4269-9909-bb903d24fd7a",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "katelynn",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "356b5c7d-ce22-4283-89bb-4b53eea09755",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/356b5c7d-ce22-4283-89bb-4b53eea09755"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "bbc375cd-6a87-494e-ad50-a176fad790a5",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/bbc375cd-6a87-494e-ad50-a176fad790a5"
}
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - {
- "id": "ba218162-d019-4617-aa1c-f21afa4922fe",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "laurena_bergnaum"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "e871d4fe-02e0-40f6-8040-69ea2f68bdba",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/e871d4fe-02e0-40f6-8040-69ea2f68bdba"
}
}, - "parents": {
- "data": [
- {
- "id": "61bf1fae-7c57-4269-9909-bb903d24fd7a",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "b72ab22f-1bad-44a9-b836-57390727210b",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/b72ab22f-1bad-44a9-b836-57390727210b"
}
}, - "project": {
- "data": {
- "id": "61bf1fae-7c57-4269-9909-bb903d24fd7a",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "assets": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false,
- "has_any": true
}
}Creates a change in a specific project, environment or asset.
Notes:
changes path
(e.g. POST to /api/projects/{project_code}/changes) the parent_path request attributes must not be supplied
as the parent will be derived from the path./api/projects/{project_code}/assets/{asset_code}/changes)
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.required | object |
{- "data": {
- "attributes": {
- "metadata": {
- "microchip": "indexing"
}, - "scheduled_activity_id": null,
- "build_without_cache": false,
- "pod_per_step": true,
- "action_path": null,
- "action": "parse",
- "parent_path": "/projects/opc/environments/dev/assets/env_soa",
- "template_version": "2023_Q4_2"
}
}
}{- "data": {
- "id": "df947b1d-50c8-45ce-a79f-54614460471f",
- "type": "change",
- "attributes": {
- "created_by": "wilma",
- "name": null,
- "action": "hack",
- "build_without_cache": false,
- "initial_step_tree": { },
- "metadata": {
- "port": "parsing"
}, - "scheduled": false,
- "approved_by": [ ],
- "rejected_by": [ ],
- "cancelled_by": null,
- "status_code": "initializing",
- "mintmodel_change": false,
- "created_at": "2026-02-23T07:57:54.056594Z",
- "started_at": "2026-02-23T07:57:54.050661Z",
- "finished_at": null,
- "updated_at": "2026-02-23T07:57:54.065984Z",
- "asset_name": null,
- "environment_name": "Development",
- "project_name": "OpsChain",
- "git_remote_name": "github",
- "git_rev": "main",
- "commit_sha": null,
- "requires_approval_from": "opschain"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "4cc87b93-f1d6-4d71-9d79-5310d9b4b2b2",
- "type": "project"
}, - {
- "id": "f76963b0-d990-4754-b050-9080b9f14c14",
- "type": "environment"
}
]
}, - "root_step": {
- "data": {
- "id": "7bd6718a-41cb-4787-a520-37288041363c",
- "type": "step"
}, - "links": {
- "related": "/api/steps/7bd6718a-41cb-4787-a520-37288041363c"
}
}, - "steps": {
- "data": [
- {
- "id": "7bd6718a-41cb-4787-a520-37288041363c",
- "type": "step"
}
]
}, - "workflow_run": {
- "data": null
}, - "workflow": {
- "data": null
}, - "override_properties": {
- "data": {
- "id": "42ec7bd7-3437-42a9-8a68-32aafdbd57d2",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/42ec7bd7-3437-42a9-8a68-32aafdbd57d2"
}
}, - "override_settings": {
- "data": {
- "id": "1ee874f8-1306-4f04-8310-eaede452fd1f",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/1ee874f8-1306-4f04-8310-eaede452fd1f"
}
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/6d38bd22-6db2-46e9-ac4d-55dac094b23b",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/projects/opc/environments/dev/changes/df947b1d-50c8-45ce-a79f-54614460471f",
- "log_lines": "/api/changes/df947b1d-50c8-45ce-a79f-54614460471f/log_lines"
}, - "meta": { }
}, - "included": [
- {
- "id": "7bd6718a-41cb-4787-a520-37288041363c",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": "opschain",
- "action": "hack",
- "name": null,
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "df947b1d-50c8-45ce-a79f-54614460471f",
- "skip_on_retry": false,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:57:54.058952Z",
- "started_at": "2026-02-23T07:57:54.050661Z",
- "finished_at": null,
- "updated_at": "2026-02-23T07:57:54.065984Z",
- "status_code": "initializing"
}, - "relationships": {
- "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [ ]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "df947b1d-50c8-45ce-a79f-54614460471f",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/df947b1d-50c8-45ce-a79f-54614460471f",
- "change": "/api/projects/opc/environments/dev/changes/df947b1d-50c8-45ce-a79f-54614460471f",
- "log_lines": "/api/steps/7bd6718a-41cb-4787-a520-37288041363c/log_lines",
- "self": "/api/steps/7bd6718a-41cb-4787-a520-37288041363c"
}, - "meta": { }
}
]
}Shows a change, including it's parent nodes.
| change_id required | string Example: 8fd8948d-7d9e-4d76-94de-512065c0e048 change id |
| include | string Example: include=steps,parents Include the change steps and parents in the response |
{- "data": {
- "id": "bddc8673-aee2-4447-bf3e-8f91a2b07669",
- "type": "change",
- "attributes": {
- "created_by": "trent.sipes",
- "name": "parse",
- "action": "parse",
- "build_without_cache": false,
- "initial_step_tree": { },
- "metadata": {
- "circuit": "quantifying"
}, - "scheduled": false,
- "approved_by": [ ],
- "rejected_by": [ ],
- "cancelled_by": null,
- "status_code": "success",
- "mintmodel_change": false,
- "created_at": "2026-02-23T07:57:54.497916Z",
- "started_at": "2026-02-23T07:51:38.658183Z",
- "finished_at": "2026-02-23T07:55:26.382131Z",
- "updated_at": "2026-02-23T07:57:54.505098Z",
- "asset_name": null,
- "environment_name": "Development",
- "project_name": "OpsChain",
- "git_remote_name": "github",
- "git_rev": "main",
- "commit_sha": "98f6fbcee335c508cfcfd879b7cdf6b924c2c99e",
- "requires_approval_from": null
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01b5338c-c35b-4662-b817-a3a1eec5e608",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01b5338c-c35b-4662-b817-a3a1eec5e608"
}
}, - "parents": {
- "data": [
- {
- "id": "7612b959-6432-4281-b236-5bf8587f26b4",
- "type": "project"
}, - {
- "id": "97a3822e-acf3-4345-a619-9e5f375f918c",
- "type": "environment"
}
]
}, - "root_step": {
- "data": {
- "id": "36872fa2-e88d-4cc4-805e-b5cb6d05cdb4",
- "type": "step"
}, - "links": {
- "related": "/api/steps/36872fa2-e88d-4cc4-805e-b5cb6d05cdb4"
}
}, - "steps": {
- "data": [
- {
- "id": "36872fa2-e88d-4cc4-805e-b5cb6d05cdb4",
- "type": "step"
}
]
}, - "workflow_run": {
- "data": null
}, - "workflow": {
- "data": null
}, - "override_properties": {
- "data": {
- "id": "1dbb5b34-6fc0-46ae-9446-73ef69e63d99",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/1dbb5b34-6fc0-46ae-9446-73ef69e63d99"
}
}, - "override_settings": {
- "data": {
- "id": "de53d771-81a7-4ccc-8694-1b599257c37e",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/de53d771-81a7-4ccc-8694-1b599257c37e"
}
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/8ecc2b4b-e500-4fe8-ba8d-b8f3cd6763be",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/projects/opc/environments/dev/changes/bddc8673-aee2-4447-bf3e-8f91a2b07669",
- "log_lines": "/api/changes/bddc8673-aee2-4447-bf3e-8f91a2b07669/log_lines"
}, - "meta": {
- "parallel_changes_allowed": true,
- "parallel_runs_of_same_change_allowed": false,
- "blocked_by_change_in_same_parent": false,
- "blocked_by_queue": [ ]
}
}, - "included": [
- {
- "id": "36872fa2-e88d-4cc4-805e-b5cb6d05cdb4",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "action": "parse",
- "name": "parse",
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "bddc8673-aee2-4447-bf3e-8f91a2b07669",
- "skip_on_retry": false,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:50:38.658183Z",
- "started_at": "2026-02-23T07:51:38.658183Z",
- "finished_at": "2026-02-23T07:55:26.382131Z",
- "updated_at": "2026-02-23T07:57:54.505098Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "01b5338c-c35b-4662-b817-a3a1eec5e608",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/01b5338c-c35b-4662-b817-a3a1eec5e608"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "b9b60155-77c1-428c-b278-4351c7ba09d4",
- "type": "properties_version"
}, - {
- "id": "31766780-9bcb-4471-84eb-e2ecc3ef0f69",
- "type": "properties_version"
}, - {
- "id": "28fda8ce-ea57-44a9-8d89-bb8208ba72b7",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "bddc8673-aee2-4447-bf3e-8f91a2b07669",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/bddc8673-aee2-4447-bf3e-8f91a2b07669",
- "change": "/api/projects/opc/environments/dev/changes/bddc8673-aee2-4447-bf3e-8f91a2b07669",
- "log_lines": "/api/steps/36872fa2-e88d-4cc4-805e-b5cb6d05cdb4/log_lines",
- "self": "/api/steps/36872fa2-e88d-4cc4-805e-b5cb6d05cdb4"
}, - "meta": { }
}, - {
- "id": "7612b959-6432-4281-b236-5bf8587f26b4",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "magnolia.lakin",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "81f542f1-e2f8-4526-b488-0d783ca22166",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/81f542f1-e2f8-4526-b488-0d783ca22166"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "923e8207-c69b-4d40-aa20-458374767c0c",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/923e8207-c69b-4d40-aa20-458374767c0c"
}
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - {
- "id": "97a3822e-acf3-4345-a619-9e5f375f918c",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "nancie_schumm"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "2532d2c3-7ae2-40af-a2ed-a8f8267af939",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/2532d2c3-7ae2-40af-a2ed-a8f8267af939"
}
}, - "parents": {
- "data": [
- {
- "id": "7612b959-6432-4281-b236-5bf8587f26b4",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "9ce149c9-c224-40fc-841e-7782136b20ca",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/9ce149c9-c224-40fc-841e-7782136b20ca"
}
}, - "project": {
- "data": {
- "id": "7612b959-6432-4281-b236-5bf8587f26b4",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "assets": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
]
}Converge the root step properties for a change.
The optional action_stage argument can be:
| change_id required | string Example: 8fd8948d-7d9e-4d76-94de-512065c0e048 change id |
| action_stage | string Example: action_stage=pre Converge the pre or post action properties |
{- "data": {
- "id": "program (post)",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}, - "application": "calculating"
}
}, - "relationships": {
- "repository_properties": {
- "data": [ ]
}, - "properties": {
- "data": [
- {
- "id": "41baa713-872f-43dc-9270-ccd481847929",
- "type": "properties_version"
}, - {
- "id": "5da3bf43-7c72-4b61-a3be-b0806e9259f0",
- "type": "properties_version"
}, - {
- "id": "e2f22c0f-f19d-4c54-bd62-20090e1a9f7e",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}, - "application": "Change: Change properties"
}, - "by_source": { }
}
}
}, - "included": [
- {
- "id": "41baa713-872f-43dc-9270-ccd481847929",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-02-23T07:57:55.460192Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "e66b0e2f-9de0-4758-9446-bd77b947ff3a",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/e66b0e2f-9de0-4758-9446-bd77b947ff3a"
}
}
}, - "links": {
- "versions": "/api/properties/e66b0e2f-9de0-4758-9446-bd77b947ff3a/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/e66b0e2f-9de0-4758-9446-bd77b947ff3a/versions/1"
}, - "meta": { }
}, - {
- "id": "5da3bf43-7c72-4b61-a3be-b0806e9259f0",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-02-23T07:57:55.487744Z",
- "owner_type": "Environment"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "fc4f2786-5474-448d-8495-3518a392d61b",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/fc4f2786-5474-448d-8495-3518a392d61b"
}
}
}, - "links": {
- "versions": "/api/properties/fc4f2786-5474-448d-8495-3518a392d61b/versions",
- "owner": "/api/projects/opc/environments/dev",
- "self": "/api/properties/fc4f2786-5474-448d-8495-3518a392d61b/versions/1"
}, - "meta": { }
}, - {
- "id": "e2f22c0f-f19d-4c54-bd62-20090e1a9f7e",
- "type": "properties_version",
- "attributes": {
- "data": {
- "application": "calculating"
}, - "version": 1,
- "created_at": "2026-02-23T07:57:55.558116Z",
- "owner_type": "Change"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "95c355c4-f9f1-430d-8cea-ca24f68dbbf3",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/95c355c4-f9f1-430d-8cea-ca24f68dbbf3"
}
}
}, - "links": {
- "versions": "/api/properties/95c355c4-f9f1-430d-8cea-ca24f68dbbf3/versions",
- "owner": "/api/projects/opc/environments/dev/changes/1d5fb268-51c7-449d-b753-342c433601ce",
- "self": "/api/properties/95c355c4-f9f1-430d-8cea-ca24f68dbbf3/versions/1"
}, - "meta": { }
}
]
}Lists all scheduled activities.
| filter[<query/sort filter>]= | |
| include | string Example: include=parents Include the scheduled change parents in the response |
{- "data": [
- {
- "id": "8e82f965-bd2a-4b01-8184-c7bdf8eef387",
- "type": "scheduled_change",
- "attributes": {
- "created_by": "wesley",
- "cron_schedule": "47 17 1 12 *",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "enabled": true,
- "allow_parallel_execution": false,
- "metadata": {
- "circuit": "backing up"
}, - "property_overrides": {
- "capacitor": "programming"
}, - "created_at": "2026-02-23T07:57:46.336882Z",
- "updated_at": "2026-02-23T07:57:46.336882Z",
- "next_run_at": "2026-12-01T06:47:00.000000Z",
- "run_at": null,
- "end_at": null,
- "action": "transmit",
- "new_commits_only": true,
- "git_rev": "virtual",
- "project_name": "OpsChain",
- "project_code": "opc",
- "settings_overrides": {
- "dockerfile": "Dockerfile_custom"
}, - "asset_code": null,
- "asset_name": null,
- "environment_code": "dev",
- "environment_name": "Development",
- "git_remote_name": "github"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "1cd64d4b-96f8-4558-80fe-bcc0662a7557",
- "type": "project"
}, - {
- "id": "7c8e18b7-56a2-4f6a-bc22-5fdfffa28a24",
- "type": "environment"
}
]
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/6dcc6e05-1e54-4bec-9d6f-86122dcb1f26",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/scheduled_activities/8e82f965-bd2a-4b01-8184-c7bdf8eef387"
}
}, - {
- "id": "905d5367-b886-432d-b38f-90ab0640f831",
- "type": "scheduled_workflow",
- "attributes": {
- "created_by": "moises",
- "cron_schedule": "26 22 25 12 1",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "enabled": true,
- "allow_parallel_execution": false,
- "metadata": {
- "firewall": "bypassing"
}, - "property_overrides": {
- "capacitor": "generating"
}, - "created_at": "2026-02-23T07:57:46.607042Z",
- "updated_at": "2026-02-23T07:57:46.607042Z",
- "next_run_at": "2026-12-07T11:26:00.000000Z",
- "run_at": null,
- "end_at": null,
- "workflow_code": "assets",
- "version": 2,
- "project_name": "OpsChain",
- "project_code": "opc"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "1cd64d4b-96f8-4558-80fe-bcc0662a7557",
- "type": "project"
}
]
}
}, - "links": {
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc",
- "self": "/api/scheduled_activities/905d5367-b886-432d-b38f-90ab0640f831",
- "workflow": "/api/projects/opc/workflows/assets",
- "workflow_version": "/api/projects/opc/workflows/assets/versions/2"
}
}
], - "included": [
- {
- "id": "1cd64d4b-96f8-4558-80fe-bcc0662a7557",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "concha",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "0e1a7033-cd17-42d6-a416-c8899913a5ed",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/0e1a7033-cd17-42d6-a416-c8899913a5ed"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "4d4e0c5a-2825-40e3-a932-70bdec76384d",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/4d4e0c5a-2825-40e3-a932-70bdec76384d"
}
}, - "children": {
- "data": [
- {
- "id": "7c8e18b7-56a2-4f6a-bc22-5fdfffa28a24",
- "type": "environment"
}, - {
- "id": "68ebcd92-d0a3-4b2c-8dec-d931326f6e64",
- "type": "asset"
}, - {
- "id": "21991426-70e8-4ba2-9a4a-6ae217240a60",
- "type": "asset"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - {
- "id": "7c8e18b7-56a2-4f6a-bc22-5fdfffa28a24",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "danuta_jacobson"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "258b5cb0-9290-414a-aa07-e1d23d768062",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/258b5cb0-9290-414a-aa07-e1d23d768062"
}
}, - "parents": {
- "data": [
- {
- "id": "1cd64d4b-96f8-4558-80fe-bcc0662a7557",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "d92aeeeb-4b79-4f8c-b5a9-afbe5e41608e",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/d92aeeeb-4b79-4f8c-b5a9-afbe5e41608e"
}
}, - "project": {
- "data": {
- "id": "1cd64d4b-96f8-4558-80fe-bcc0662a7557",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "assets": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "has_any": true
}
}Creates a scheduled activity in a specific project, environment or asset.
Notes:
When creating scheduled activities via a project, environment or asset scheduled_activities path
(e.g. POST to /api/projects/{project_code}/scheduled_activities) the parent_path request attributes must not be supplied
as the parent will be derived from the path.
When creating scheduled activities for assets (e.g. POST to /api/projects/{project_code}/assets/{asset_code}/scheduled_activities)
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.
See the various payload examples to understand the required fields for each possible request to this endpoint.
required | object |
{- "data": {
- "attributes": {
- "git_rev": "master",
- "action": "install_os",
- "cron_schedule": "43 1 9 7 1",
- "new_commits_only": false,
- "repeat": true,
- "metadata": {
- "feed": "connecting"
}, - "run_at": null,
- "run_count": 0,
- "maximum_run_count": null,
- "end_at": null,
- "allow_parallel_execution": false,
- "property_overrides": {
- "capacitor": "overriding"
}, - "settings_overrides": {
- "repo_folder": "backing up"
}, - "parent_path": "/projects/opc/environments/dev",
- "git_remote_name": "github"
}
}
}{- "data": {
- "id": "02df7d10-0072-4c7c-b2b7-6fd3523fdeb6",
- "type": "scheduled_change",
- "attributes": {
- "created_by": "betsy_waters",
- "cron_schedule": "4 17 11 5 2",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "enabled": true,
- "allow_parallel_execution": false,
- "metadata": {
- "transmitter": "calculating"
}, - "property_overrides": {
- "protocol": "bypassing"
}, - "created_at": "2026-02-23T07:57:47.264031Z",
- "updated_at": "2026-02-23T07:57:47.264031Z",
- "next_run_at": "2026-05-05T07:04:00.000000Z",
- "run_at": null,
- "end_at": null,
- "action": "different_action",
- "new_commits_only": true,
- "git_rev": "bluetooth",
- "project_name": "OpsChain",
- "project_code": "opc",
- "settings_overrides": {
- "dockerfile": "synthesizing"
}, - "asset_code": null,
- "asset_name": null,
- "environment_code": "dev",
- "environment_name": "Development",
- "git_remote_name": "github"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "cfdd608e-6839-4205-93f2-1ba8c5e31423",
- "type": "project"
}, - {
- "id": "efe8d08b-a563-4b80-9865-e79db67e452f",
- "type": "environment"
}
]
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/0b3bfc4c-f61d-4f8b-b23c-f12102d99f69",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/scheduled_activities/02df7d10-0072-4c7c-b2b7-6fd3523fdeb6"
}
}
}Shows a scheduled activity.
| scheduled_change_id required | string Example: 49be9d7b-bd23-4d9e-9fdc-526c0345f0c2 scheduled change id |
| include | string Example: include=parents Include the scheduled change parents in the response |
{- "data": {
- "id": "9085f9cd-4ab7-43bd-8ae2-4db83aeadd8f",
- "type": "scheduled_change",
- "attributes": {
- "created_by": "taina.buckridge",
- "cron_schedule": "1 4 11 7 0",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": null,
- "enabled": true,
- "allow_parallel_execution": false,
- "metadata": {
- "interface": "transmitting"
}, - "property_overrides": {
- "circuit": "transmitting"
}, - "created_at": "2026-02-23T07:57:47.799778Z",
- "updated_at": "2026-02-23T07:57:47.799778Z",
- "next_run_at": "2026-07-04T18:01:00.000000Z",
- "run_at": null,
- "end_at": null,
- "action": "copy",
- "new_commits_only": false,
- "git_rev": "optical",
- "project_name": "OpsChain",
- "project_code": "opc",
- "settings_overrides": {
- "dockerfile": "Dockerfile_custom"
}, - "asset_code": null,
- "asset_name": null,
- "environment_code": "dev",
- "environment_name": "Development",
- "git_remote_name": "github"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "61af110d-bd52-4eb1-9157-d9d282e50c16",
- "type": "project"
}, - {
- "id": "37bf88ab-e080-4e38-a65b-02b5eba15c15",
- "type": "environment"
}
]
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/97295d21-d80a-4880-9767-e90958a610a8",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/scheduled_activities/9085f9cd-4ab7-43bd-8ae2-4db83aeadd8f"
}
}, - "included": [
- {
- "id": "61af110d-bd52-4eb1-9157-d9d282e50c16",
- "type": "project",
- "attributes": {
- "code": "opc",
- "name": "OpsChain",
- "description": "OpsChain project",
- "archived": false,
- "created_by": "randi",
- "project_type": "Enterprise"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "d370a6e3-4ac5-4615-a609-49cfef1d7ec6",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/d370a6e3-4ac5-4615-a609-49cfef1d7ec6"
}
}, - "parents": {
- "data": [ ]
}, - "settings": {
- "data": {
- "id": "c5f3b179-7dc0-4adf-b754-1b70965bd2bf",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/c5f3b179-7dc0-4adf-b754-1b70965bd2bf"
}
}, - "children": {
- "data": [
- {
- "id": "37bf88ab-e080-4e38-a65b-02b5eba15c15",
- "type": "environment"
}, - {
- "id": "5a289d13-3c67-4103-918d-55be7cc385f2",
- "type": "asset"
}, - {
- "id": "b411f015-b905-4bff-ad4f-92b03d66062e",
- "type": "asset"
}
]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc",
- "bookmarks": "/api/projects/opc/bookmarks",
- "changes": "/api/projects/opc/changes",
- "scheduled_activities": "/api/projects/opc/scheduled_activities",
- "git_remotes": "/api/projects/opc/git_remotes",
- "workflows": "/api/projects/opc/workflows",
- "workflow_runs": "/api/projects/opc/workflow_runs",
- "templates": "/api/projects/opc/templates",
- "environments": "/api/projects/opc/environments",
- "assets": "/api/projects/opc/assets",
- "agents": "/api/projects/opc/agents"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": true,
- "requires_template": false,
- "child_node_types": [
- "environment",
- "asset",
- "agent"
], - "can_have_workflows": true,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "git_remotes": {
- "read": true,
- "update": true
}, - "templates": {
- "read": true,
- "update": true
}, - "workflows": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "workflow_runs": {
- "read": true,
- "execute": true
}, - "environments": {
- "read": true,
- "update": true
}, - "assets": {
- "read": true,
- "update": true
}, - "agents": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}, - {
- "id": "37bf88ab-e080-4e38-a65b-02b5eba15c15",
- "type": "environment",
- "attributes": {
- "code": "dev",
- "name": "Development",
- "description": "OpsChain development environment",
- "archived": false,
- "created_by": "zackary_satterfield"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "cddc7764-b73b-48e1-ba32-4115d036b6c3",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/cddc7764-b73b-48e1-ba32-4115d036b6c3"
}
}, - "parents": {
- "data": [
- {
- "id": "61af110d-bd52-4eb1-9157-d9d282e50c16",
- "type": "project"
}
]
}, - "settings": {
- "data": {
- "id": "b613ec5f-a072-46e4-96cf-eecbc0777c21",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/b613ec5f-a072-46e4-96cf-eecbc0777c21"
}
}, - "project": {
- "data": {
- "id": "61af110d-bd52-4eb1-9157-d9d282e50c16",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}, - "children": {
- "data": [ ]
}, - "bookmarks": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev",
- "bookmarks": "/api/projects/opc/environments/dev/bookmarks",
- "changes": "/api/projects/opc/environments/dev/changes",
- "scheduled_activities": "/api/projects/opc/environments/dev/scheduled_activities",
- "parent": "/api/projects/opc",
- "assets": "/api/projects/opc/environments/dev/assets"
}, - "meta": {
- "can_have_changes": true,
- "can_have_children": true,
- "can_have_properties": true,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [
- "asset"
], - "can_have_workflows": false,
- "authorisations": {
- "properties": {
- "read": true,
- "update": true
}, - "settings": {
- "read": true,
- "update": true
}, - "scheduled_activities": {
- "read": true,
- "update": true
}, - "changes": {
- "read": true,
- "execute": true
}, - "assets": {
- "read": true,
- "update": true
}, - "secrets": {
- "settings": false,
- "properties": false,
- "mintmodel": false
}, - "self": {
- "update": true
}
}
}
}
]
}Updates a scheduled activity in a specific project, environment or asset.
Notes:
scheduled_activities path
(e.g. POST to /api/projects/{project_code}/scheduled_activities) the parent_path request attributes must not be supplied
as the parent will be derived from the path./api/projects/{project_code}/assets/{asset_code}/scheduled_activities)
the git_remote_name and git_rev attributes must not be supplied as the Git remote and revision will be
derived from the asset's template.| scheduled_change_id required | string Example: 49be9d7b-bd23-4d9e-9fdc-526c0345f0c2 scheduled change id |
required | object |
{- "data": {
- "attributes": {
- "git_rev": "master",
- "action": "install_os",
- "cron_schedule": "3 10 28 12 1",
- "new_commits_only": false,
- "repeat": true,
- "metadata": {
- "capacitor": "quantifying"
}, - "run_at": null,
- "run_count": 0,
- "maximum_run_count": null,
- "end_at": null,
- "allow_parallel_execution": false,
- "property_overrides": {
- "pixel": "bypassing"
}, - "settings_overrides": {
- "repo_folder": "backing up"
}, - "parent_path": "/projects/opc/environments/dev",
- "git_remote_name": "github"
}
}
}{- "data": {
- "id": "1ed651da-6575-47d8-b2a5-c9fab9e19bc8",
- "type": "scheduled_change",
- "attributes": {
- "created_by": "bradley.nienow",
- "cron_schedule": "20 16 5 5 6",
- "repeat": true,
- "run_count": 0,
- "maximum_run_count": 5,
- "enabled": true,
- "allow_parallel_execution": false,
- "metadata": {
- "transmitter": "transmitting"
}, - "property_overrides": {
- "new": "property",
- "value": "overrides"
}, - "created_at": "2026-02-23T07:57:48.761700Z",
- "updated_at": "2026-02-23T07:57:49.012718Z",
- "next_run_at": "2026-05-02T06:20:00.000000Z",
- "run_at": null,
- "end_at": null,
- "action": "new_action",
- "new_commits_only": true,
- "git_rev": "multi-byte",
- "project_name": "OpsChain",
- "project_code": "opc",
- "settings_overrides": {
- "dockerfile": "Dockerfile_custom"
}, - "asset_code": null,
- "asset_name": null,
- "environment_code": "dev",
- "environment_name": "Development",
- "git_remote_name": "github"
}, - "relationships": {
- "parents": {
- "data": [
- {
- "id": "60979d77-3836-4b44-97aa-49fc945cc4e7",
- "type": "project"
}, - {
- "id": "2fa966ed-266d-4363-aa8f-56d44af14468",
- "type": "environment"
}
]
}
}, - "links": {
- "git_remote": "/api/projects/opc/git_remotes/fa89eec1-86ab-42d7-af48-f357cd560258",
- "project": "/api/projects/opc",
- "parent": "/api/projects/opc/environments/dev",
- "self": "/api/scheduled_activities/1ed651da-6575-47d8-b2a5-c9fab9e19bc8"
}
}
}Delete a scheduled activity.
| scheduled_change_id required | string Example: 49be9d7b-bd23-4d9e-9fdc-526c0345f0c2 scheduled change id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find BaseScheduledActivity"
}
}
]
}Endpoints to interact with change steps.
{- "data": [
- {
- "id": "6d01ec12-ff36-4a42-8b8d-8dcea9bf5cbc",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "action": "parse",
- "name": "parse",
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "c6b1179d-7859-482e-be33-a2885c92978c",
- "skip_on_retry": false,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:51:11.019807Z",
- "started_at": "2026-02-23T07:52:11.019807Z",
- "finished_at": "2026-02-23T07:54:55.194706Z",
- "updated_at": "2026-02-23T07:58:24.716858Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "c394b111-a96e-4b76-b28a-01c9643277b6",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/c394b111-a96e-4b76-b28a-01c9643277b6"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "cc80dfd3-aa22-4ca6-89c4-a2da71c62c3f",
- "type": "properties_version"
}, - {
- "id": "cd4597f9-7543-4dc9-9593-9870c8e2513d",
- "type": "properties_version"
}, - {
- "id": "ea5ff614-1fa0-4959-88a8-8ee4eec33e31",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "c6b1179d-7859-482e-be33-a2885c92978c",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/c6b1179d-7859-482e-be33-a2885c92978c",
- "change": "/api/projects/opc/environments/dev/changes/c6b1179d-7859-482e-be33-a2885c92978c",
- "log_lines": "/api/steps/6d01ec12-ff36-4a42-8b8d-8dcea9bf5cbc/log_lines",
- "self": "/api/steps/6d01ec12-ff36-4a42-8b8d-8dcea9bf5cbc"
}, - "meta": { }
}
]
}Shows a change step.
| step_id required | string Example: 8674c300-104d-406b-a08c-6f4956b9f480 step id |
{- "data": {
- "id": "4b57a910-18d4-4d67-966a-0c404dad73f2",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "action": "connect",
- "name": "connect",
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "7da6806b-387a-49e0-acfc-b932c7e6b05d",
- "skip_on_retry": false,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:47:43.940961Z",
- "started_at": "2026-02-23T07:48:43.940961Z",
- "finished_at": "2026-02-23T07:50:17.595007Z",
- "updated_at": "2026-02-23T07:58:25.036091Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "41e436ce-c7e9-40b3-a3b4-ceb6fc47be78",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/41e436ce-c7e9-40b3-a3b4-ceb6fc47be78"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "f14310e8-2afe-40ba-a2dd-780af1d5b619",
- "type": "properties_version"
}, - {
- "id": "a16cf4ac-1013-4e27-a5cd-0b5ef0e8fad6",
- "type": "properties_version"
}, - {
- "id": "35b41f8f-1586-4435-b1df-07ba3a209631",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "7da6806b-387a-49e0-acfc-b932c7e6b05d",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/7da6806b-387a-49e0-acfc-b932c7e6b05d",
- "change": "/api/projects/opc/environments/dev/changes/7da6806b-387a-49e0-acfc-b932c7e6b05d",
- "log_lines": "/api/steps/4b57a910-18d4-4d67-966a-0c404dad73f2/log_lines",
- "self": "/api/steps/4b57a910-18d4-4d67-966a-0c404dad73f2"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}, - "array": "Change: Change properties"
}, - "by_source": { }
}
}
}, - "included": [
- {
- "id": "f14310e8-2afe-40ba-a2dd-780af1d5b619",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-02-23T07:58:24.867958Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "affb25d3-140b-40f4-bbb7-47ca1bcfc774",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/affb25d3-140b-40f4-bbb7-47ca1bcfc774"
}
}
}, - "links": {
- "versions": "/api/properties/affb25d3-140b-40f4-bbb7-47ca1bcfc774/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/affb25d3-140b-40f4-bbb7-47ca1bcfc774/versions/1"
}, - "meta": { }
}, - {
- "id": "a16cf4ac-1013-4e27-a5cd-0b5ef0e8fad6",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-02-23T07:58:24.893996Z",
- "owner_type": "Environment"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "ad567827-0c67-44e1-91a6-e23fed3e7a2a",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/ad567827-0c67-44e1-91a6-e23fed3e7a2a"
}
}
}, - "links": {
- "versions": "/api/properties/ad567827-0c67-44e1-91a6-e23fed3e7a2a/versions",
- "owner": "/api/projects/opc/environments/dev",
- "self": "/api/properties/ad567827-0c67-44e1-91a6-e23fed3e7a2a/versions/1"
}, - "meta": { }
}, - {
- "id": "35b41f8f-1586-4435-b1df-07ba3a209631",
- "type": "properties_version",
- "attributes": {
- "data": {
- "array": "bypassing"
}, - "version": 1,
- "created_at": "2026-02-23T07:58:24.978427Z",
- "owner_type": "Change"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "6a405d23-737d-433b-968f-3a95466e2044",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/6a405d23-737d-433b-968f-3a95466e2044"
}
}
}, - "links": {
- "versions": "/api/properties/6a405d23-737d-433b-968f-3a95466e2044/versions",
- "owner": "/api/projects/opc/environments/dev/changes/7da6806b-387a-49e0-acfc-b932c7e6b05d",
- "self": "/api/properties/6a405d23-737d-433b-968f-3a95466e2044/versions/1"
}, - "meta": { }
}, - {
- "id": "41e436ce-c7e9-40b3-a3b4-ceb6fc47be78",
- "type": "properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}, - "array": "bypassing"
}, - "version": 1,
- "created_at": "2026-02-23T07:58:25.029715Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/steps/4b57a910-18d4-4d67-966a-0c404dad73f2"
}
}
}, - "links": {
- "self": "/api/properties/41e436ce-c7e9-40b3-a3b4-ceb6fc47be78",
- "current_version": "/api/properties/41e436ce-c7e9-40b3-a3b4-ceb6fc47be78/versions/1",
- "versions": "/api/properties/41e436ce-c7e9-40b3-a3b4-ceb6fc47be78/versions"
}
}
]
}Update a step to flag it to be skipped on retry.
| step_id required | string Example: 8674c300-104d-406b-a08c-6f4956b9f480 step id |
required | object |
{- "data": {
- "attributes": {
- "skip_on_retry": true
}
}
}{- "data": {
- "id": "3d37688e-ebf0-443c-acd4-71fd07b7f0d4",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "action": "navigate",
- "name": "navigate",
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "5b742d1f-bbc8-434c-aec1-2e884da2e368",
- "skip_on_retry": true,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:49:41.733014Z",
- "started_at": "2026-02-23T07:50:41.733014Z",
- "finished_at": "2026-02-23T07:51:59.755532Z",
- "updated_at": "2026-02-23T07:58:25.576227Z",
- "status_code": "error"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "f79705f5-f384-462e-bb6a-5491af2f9f2d",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/f79705f5-f384-462e-bb6a-5491af2f9f2d"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "dc4cf4d0-3bef-45a8-a54b-a715356f4e61",
- "type": "properties_version"
}, - {
- "id": "1b98f603-bf2b-4206-8fd0-3a5f75e0c9dd",
- "type": "properties_version"
}, - {
- "id": "3c5a517e-4fca-4251-a706-3323a7968713",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "5b742d1f-bbc8-434c-aec1-2e884da2e368",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/5b742d1f-bbc8-434c-aec1-2e884da2e368",
- "change": "/api/projects/opc/environments/dev/changes/5b742d1f-bbc8-434c-aec1-2e884da2e368",
- "log_lines": "/api/steps/3d37688e-ebf0-443c-acd4-71fd07b7f0d4/log_lines",
- "self": "/api/steps/3d37688e-ebf0-443c-acd4-71fd07b7f0d4"
}, - "meta": { }
}
}Continues a "waiting" change step.
| step_id required | string Example: 2f373212-0a2e-4543-b03e-e513f59bea72 step id |
object |
{- "data": {
- "attributes": {
- "message": "Manually removed from load balancer."
}
}
}{- "data": {
- "id": "9626c7c1-dc0b-4ea0-bc73-af6a62b6842f",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [
- {
- "username": "tosha.zulauf",
- "message": null
}
], - "requires_approval_from": null,
- "action": "quantify",
- "name": "quantify",
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "0b6bc35b-4408-48c6-bc99-93f29c8dd0e6",
- "skip_on_retry": false,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:48:18.652655Z",
- "started_at": "2026-02-23T07:49:18.652655Z",
- "finished_at": "2026-02-23T07:58:27.337590Z",
- "updated_at": "2026-02-23T07:58:27.369917Z",
- "status_code": "success"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "ee37573f-0d28-40c3-8162-534074c82ae8",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/ee37573f-0d28-40c3-8162-534074c82ae8"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "fb22e5b0-a3e1-4dbd-aea0-48bf36dbd055",
- "type": "properties_version"
}, - {
- "id": "f9b97243-7f21-4d44-9b1e-b8c6eed26641",
- "type": "properties_version"
}, - {
- "id": "cc2deb7e-49c3-4c38-8e70-f2c68dff20bd",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "0b6bc35b-4408-48c6-bc99-93f29c8dd0e6",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/0b6bc35b-4408-48c6-bc99-93f29c8dd0e6",
- "change": "/api/projects/opc/environments/dev/changes/0b6bc35b-4408-48c6-bc99-93f29c8dd0e6",
- "log_lines": "/api/steps/9626c7c1-dc0b-4ea0-bc73-af6a62b6842f/log_lines",
- "self": "/api/steps/9626c7c1-dc0b-4ea0-bc73-af6a62b6842f"
}, - "meta": { }
}
}Approves a change step that needs approval.
| step_id required | string Example: 2f373212-0a2e-4543-b03e-e513f59bea72 step id |
object |
{- "data": {
- "attributes": {
- "message": "As per CR 7 👍"
}
}
}{- "data": {
- "id": "58146864-cd15-4911-93b2-ca1028148083",
- "type": "step",
- "attributes": {
- "approved_by": [
- {
- "username": "winston",
- "message": null
}
], - "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": "an-ldap-group",
- "action": "program",
- "name": "program",
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "b5e5b6fe-a6a6-4849-8fd1-a94851e639cd",
- "skip_on_retry": false,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:47:55.589853Z",
- "started_at": "2026-02-23T07:48:55.589853Z",
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:28.088273Z",
- "status_code": "queued"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "980172b7-4eee-4fc4-8f51-6cc97aebd4cc",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/980172b7-4eee-4fc4-8f51-6cc97aebd4cc"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "889a6273-c22e-432e-b162-262804432368",
- "type": "properties_version"
}, - {
- "id": "7811aa20-edf9-4edd-a71a-02c05b1f35aa",
- "type": "properties_version"
}, - {
- "id": "d3b0fd12-58a4-4f5a-911a-56db92fb02eb",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "b5e5b6fe-a6a6-4849-8fd1-a94851e639cd",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/b5e5b6fe-a6a6-4849-8fd1-a94851e639cd",
- "change": "/api/projects/opc/environments/dev/changes/b5e5b6fe-a6a6-4849-8fd1-a94851e639cd",
- "log_lines": "/api/steps/58146864-cd15-4911-93b2-ca1028148083/log_lines",
- "self": "/api/steps/58146864-cd15-4911-93b2-ca1028148083"
}, - "meta": { }
}
}Rejects a change step that needs approval.
| step_id required | string Example: 2f373212-0a2e-4543-b03e-e513f59bea72 step id |
object |
{- "data": {
- "attributes": {
- "message": "Failed user acceptance testing"
}
}
}{- "data": {
- "id": "39e397c1-4c9b-4a30-831f-1df18d94a3da",
- "type": "step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [
- {
- "username": "krystina_cole",
- "message": null
}
], - "continued_by": [ ],
- "requires_approval_from": "an-ldap-group",
- "action": "reboot",
- "name": "reboot",
- "step_type": "standard",
- "child_execution_strategy": "sequential",
- "change_id": "a49fd95f-fbf9-4090-beb0-9a41bda8e9c0",
- "skip_on_retry": false,
- "step_sequence": 1,
- "created_at": "2026-02-23T07:48:09.882595Z",
- "started_at": "2026-02-23T07:49:09.882595Z",
- "finished_at": "2026-02-23T07:58:29.056707Z",
- "updated_at": "2026-02-23T07:58:29.064668Z",
- "status_code": "rejected"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "2621c8da-11ec-4c40-b711-23e64a8648c1",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/2621c8da-11ec-4c40-b711-23e64a8648c1"
}
}, - "children": {
- "data": [ ]
}, - "pre_properties_versions": {
- "data": [
- {
- "id": "b2417f5a-25f2-4428-8b90-e1830c5f18cc",
- "type": "properties_version"
}, - {
- "id": "8a197aed-6fa9-4695-8fef-4ea2d09551f8",
- "type": "properties_version"
}, - {
- "id": "da8bf2e0-ad6f-43e7-a5e6-6ac64403e3a6",
- "type": "properties_version"
}
]
}, - "post_properties_versions": {
- "data": [ ]
}, - "change": {
- "data": {
- "id": "a49fd95f-fbf9-4090-beb0-9a41bda8e9c0",
- "type": "change"
}
}
}, - "links": {
- "parent": "/api/changes/a49fd95f-fbf9-4090-beb0-9a41bda8e9c0",
- "change": "/api/projects/opc/environments/dev/changes/a49fd95f-fbf9-4090-beb0-9a41bda8e9c0",
- "log_lines": "/api/steps/39e397c1-4c9b-4a30-831f-1df18d94a3da/log_lines",
- "self": "/api/steps/39e397c1-4c9b-4a30-831f-1df18d94a3da"
}, - "meta": { }
}
}Converge the properties for a step.
The optional action_stage argument can be:
| step_id required | string Example: 8674c300-104d-406b-a08c-6f4956b9f480 step id |
| action_stage | string Example: action_stage=pre Converge the pre or post action properties |
{- "data": {
- "id": "parse (post)",
- "type": "converged_properties",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}, - "system": "compressing"
}
}, - "relationships": {
- "repository_properties": {
- "data": [ ]
}, - "properties": {
- "data": [
- {
- "id": "71129306-ba66-4955-905d-1b2a44c96fc8",
- "type": "properties_version"
}, - {
- "id": "3d566371-2d7c-416d-adc7-547b6cbfabde",
- "type": "properties_version"
}, - {
- "id": "3626f4d8-f2bb-4727-bc57-800d3f68fd12",
- "type": "properties_version"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/environments/dev/converged_properties"
}, - "meta": {
- "property_sources": {
- "by_property": {
- "any_key": "Project: OpsChain (opc)",
- "another_key": "Project: OpsChain (opc)",
- "nested": {
- "key": "Project: OpsChain (opc)"
}, - "system": "Change: Change properties"
}, - "by_source": { }
}
}
}, - "included": [
- {
- "id": "71129306-ba66-4955-905d-1b2a44c96fc8",
- "type": "properties_version",
- "attributes": {
- "data": {
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}, - "version": 1,
- "created_at": "2026-02-23T07:58:29.811779Z",
- "owner_type": "Project"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "73b04da4-48b0-4b55-b04e-29669103df48",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/73b04da4-48b0-4b55-b04e-29669103df48"
}
}
}, - "links": {
- "versions": "/api/properties/73b04da4-48b0-4b55-b04e-29669103df48/versions",
- "owner": "/api/projects/opc",
- "self": "/api/properties/73b04da4-48b0-4b55-b04e-29669103df48/versions/1"
}, - "meta": { }
}, - {
- "id": "3d566371-2d7c-416d-adc7-547b6cbfabde",
- "type": "properties_version",
- "attributes": {
- "data": { },
- "version": 1,
- "created_at": "2026-02-23T07:58:29.833926Z",
- "owner_type": "Environment"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "bf7398ec-87bc-4d4f-9845-6fcebac3fab6",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/bf7398ec-87bc-4d4f-9845-6fcebac3fab6"
}
}
}, - "links": {
- "versions": "/api/properties/bf7398ec-87bc-4d4f-9845-6fcebac3fab6/versions",
- "owner": "/api/projects/opc/environments/dev",
- "self": "/api/properties/bf7398ec-87bc-4d4f-9845-6fcebac3fab6/versions/1"
}, - "meta": { }
}, - {
- "id": "3626f4d8-f2bb-4727-bc57-800d3f68fd12",
- "type": "properties_version",
- "attributes": {
- "data": {
- "system": "compressing"
}, - "version": 1,
- "created_at": "2026-02-23T07:58:29.968442Z",
- "owner_type": "Change"
}, - "relationships": {
- "properties": {
- "data": {
- "id": "660eea35-be15-4566-a675-d97465fc6fd4",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/660eea35-be15-4566-a675-d97465fc6fd4"
}
}
}, - "links": {
- "versions": "/api/properties/660eea35-be15-4566-a675-d97465fc6fd4/versions",
- "owner": "/api/projects/opc/environments/dev/changes/b09bbb19-2673-4fdb-a796-6c17da20193b",
- "self": "/api/properties/660eea35-be15-4566-a675-d97465fc6fd4/versions/1"
}, - "meta": { }
}
]
}List the log lines for a change.
| change_id required | string Example: 8fd8948d-7d9e-4d76-94de-512065c0e048 |
| filter[<query/sort filter>]= | |
| download | string Example: download=change.log Download the log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "eb401a68-e12c-4ed6-be45-aa3ab4b6e8ad",
- "type": "log_line",
- "attributes": {
- "message": "Dolore soluta recusandae et.",
- "category": "action",
- "change_id": "94c79f63-0c9f-424e-a02e-52ba168ac332",
- "step_id": "81038393-9a3f-4dfd-8f45-375760b9c3c5",
- "logged_at": "2026-02-22T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List the log lines for a change step.
| step_id required | string Example: 8674c300-104d-406b-a08c-6f4956b9f480 |
| include_child_steps | boolean Example: include_child_steps=true Whether to include logs for steps that are children of this step |
| filter[<query/sort filter>]= | |
| download | string Example: download=step.log Download the log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "cbf2fdd9-e6e1-43ba-9a0f-ef07036fbf95",
- "type": "log_line",
- "attributes": {
- "message": "Id tempora molestias sed.",
- "category": "action",
- "change_id": "10062400-0542-4b5f-88cd-72ad01f1def7",
- "step_id": "0c54c532-a56f-4d03-95b9-a832b50aa33f",
- "logged_at": "2026-02-22T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List filtered log lines.
| filter[<query/sort filter>]= | |
| limit | integer [ 1 .. null ] Default: 10000 Example: limit=50 Limit the number of log lines returned |
| download | string Example: download=opschain.log Download the filtered log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "21163e0e-678c-4338-a96b-29f3e3ecdd81",
- "type": "log_line",
- "attributes": {
- "message": "Fugiat nesciunt ullam eum.",
- "category": "action",
- "change_id": "a6832a0c-8fb9-493f-a9b5-647daf82ae90",
- "step_id": "32fab3cb-ae42-4446-ab1b-f0269043224c",
- "logged_at": "2026-02-22T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List the workflow run log lines for a workflow run.
| workflow_run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 |
| filter[<query/sort filter>]= | |
| download | string Example: download=workflow_run.log Download the log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "dff1383c-3dc8-4069-92d2-f32489b58a40",
- "type": "log_line",
- "attributes": {
- "message": "Temporibus quas officia sit.",
- "category": "action",
- "workflow_run_id": "10fe7f1f-68e6-4504-9835-57a8100fde87",
- "workflow_step_id": "6f6830ba-3dd2-467e-be11-447f0a36173f",
- "logged_at": "2026-02-22T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List the log lines for a workflow step.
| workflow_step_id required | string Example: aff62781-be2d-4a78-a0c3-1828e44c1c00 |
| include_child_steps | boolean Example: include_child_steps=true Whether to include logs for steps that are children of this step |
| filter[<query/sort filter>]= | |
| download | string Example: download=workflow_step.log Download the log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "84ad651d-a6b3-402c-908c-c7f8b93d0e2f",
- "type": "log_line",
- "attributes": {
- "message": "Et et eveniet ipsa.",
- "category": "action",
- "workflow_run_id": "673934c0-b7e5-47eb-ac54-5f94481badf2",
- "workflow_step_id": "51c56a38-f409-4b1c-81dd-15536d57d439",
- "logged_at": "2026-02-22T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}List filtered workflow run log lines.
| filter[<query/sort filter>]= | |
| limit | integer [ 1 .. null ] Default: 10000 Example: limit=50 Limit the number of workflow run log lines returned |
| download | string Example: download=opschain.log Download the filtered log lines wth the specified file name. The logs will be ordered from oldest to newest when this parameter is specified, irrespective of the sort order requested. |
{- "data": [
- {
- "id": "b0bf756a-9d86-47d9-b56c-1eee2a54c409",
- "type": "log_line",
- "attributes": {
- "message": "Sapiente et ut dolor.",
- "category": "action",
- "workflow_run_id": "b178ede7-98af-41b1-9788-6ae9286d1df4",
- "workflow_step_id": "ac44c577-2dd9-4b21-bf3e-4b5ef23e784a",
- "logged_at": "2026-02-22T00:00:00.000000Z"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Endpoints to interact with workflow runs
Notes:
/workflow_runs - will return all workflow runs accessible to the user./project/{project_code}/workflow_runs - will return all workflow runs for all this project's workflows./project/{project_code}/workflows/{workflow_code}/workflow_runs - will return all workflow runs this workflow./<path/to/asset>/workflow_runs - will return all workflow runs that include a change for this asset.{- "data": [
- {
- "id": "e055e19f-6dd2-474d-997a-a45d76e6b44c",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "ab91f98a-90e1-466d-b967-4d346c97eb71",
- "name": "ipsam",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "33b42c47-8178-4d98-a0ac-252816e92625",
- "name": "quae",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "e4744795-b42b-42f3-84b9-ebeb13f2d731",
- "name": "calculate",
- "type": "workflow_change_step",
- "action": "calculate",
- "target": "/projects/g9khe/environments/gafe7/assets/uarpm"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "352b411d-d135-40fe-8015-fd209f2d41e6",
- "name": "connect",
- "type": "workflow_change_step",
- "action": "connect",
- "target": "/projects/8lyg0/environments/ulueq/assets/ox2hh"
}, - {
- "id": "a8a0faa2-942a-4856-9340-e79ffbe888fb",
- "name": "Wait",
- "type": "workflow_wait_step"
}, - {
- "id": "622c1760-9e2e-4727-9d74-168572993016",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/roilk/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Tin": "7.2.6",
- "Bamity": "1.6.1",
- "Flexidy": "4.25",
- "Matsoft": "2.3",
- "Quo Lux": "9.3.4",
- "Veribet": "0.18",
- "Overhold": "3.96",
- "Lotstring": "2.3",
- "Voltsillam": "0.71"
}, - "created_by": "irina",
- "cancelled_by": null,
- "status_code": "success",
- "created_at": "2026-02-23T07:58:38.330601Z",
- "started_at": "2026-02-23T07:49:10.118540Z",
- "finished_at": "2026-02-23T07:52:33.987520Z",
- "updated_at": "2026-02-23T07:58:38.340024Z",
- "project_name": "OpsChain"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "0617215b-3140-415f-a2ff-a04b42b18899",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "14428ff6-d777-4f16-973f-a21c9b4974fa",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "ab91f98a-90e1-466d-b967-4d346c97eb71",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "622c1760-9e2e-4727-9d74-168572993016",
- "type": "workflow_workflow_step"
}, - {
- "id": "33b42c47-8178-4d98-a0ac-252816e92625",
- "type": "workflow_noop_step"
}, - {
- "id": "ab91f98a-90e1-466d-b967-4d346c97eb71",
- "type": "workflow_noop_step"
}, - {
- "id": "a8a0faa2-942a-4856-9340-e79ffbe888fb",
- "type": "workflow_wait_step"
}, - {
- "id": "352b411d-d135-40fe-8015-fd209f2d41e6",
- "type": "workflow_change_step"
}, - {
- "id": "e4744795-b42b-42f3-84b9-ebeb13f2d731",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "8ede9ee3-2386-436e-a6fe-737c5a03a7a3",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/8ede9ee3-2386-436e-a6fe-737c5a03a7a3"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/e055e19f-6dd2-474d-997a-a45d76e6b44c",
- "log_lines": "/api/workflow_runs/e055e19f-6dd2-474d-997a-a45d76e6b44c/log_lines"
}, - "meta": { }
}
], - "included": [
- {
- "id": "0617215b-3140-415f-a2ff-a04b42b18899",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "darell",
- "created_at": "2026-02-23T07:58:38.287396Z",
- "updated_at": "2026-02-23T07:58:38.299073Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "ff8e10e4-6760-468e-bb12-b5995f171265",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Runs a pre-defined workflow
required | object |
{- "data": {
- "attributes": {
- "project_code": "opc",
- "workflow_code": "assets",
- "version": 2,
- "property_overrides": {
- "additional": "properties"
}, - "metadata": {
- "optional": "metadata"
}
}
}
}{- "data": {
- "id": "0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "3a7e679e-feb5-4f59-af8f-60628af597e7",
- "name": "assets workflow",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "225f3e87-29c2-4222-b986-f29b8c00003b",
- "name": "run asset action",
- "type": "workflow_change_step",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": { },
- "created_by": "roberto.stamm",
- "cancelled_by": null,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:39.433365Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:39.446594Z",
- "project_name": "OpsChain"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "4ced7197-f79b-4354-8783-17cead38029d",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "9298157b-7acb-40ba-a393-5160bec6436c",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "3a7e679e-feb5-4f59-af8f-60628af597e7",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "3a7e679e-feb5-4f59-af8f-60628af597e7",
- "type": "workflow_noop_step"
}, - {
- "id": "225f3e87-29c2-4222-b986-f29b8c00003b",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "836cc824-25ee-4798-abb0-d054aebcfc97",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/836cc824-25ee-4798-abb0-d054aebcfc97"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501",
- "log_lines": "/api/workflow_runs/0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501/log_lines"
}, - "meta": { }
}, - "included": [
- {
- "id": "4ced7197-f79b-4354-8783-17cead38029d",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "vertie",
- "created_at": "2026-02-23T07:58:38.968362Z",
- "updated_at": "2026-02-23T07:58:38.980303Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa",
- "source": "steps/1",
- "change_parent": {
- "id": "51c39110-16ec-42ae-829b-55d6014a7ceb",
- "path": "/projects/opc/assets/prj_soa",
- "parent_path": "/projects/opc",
- "project_id": "e2169991-af1f-49e8-878b-4d617fcf916e",
- "node_type": "asset",
- "parent_id": "e2169991-af1f-49e8-878b-4d617fcf916e",
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_at": "2026-02-23T07:58:38.874Z",
- "updated_at": "2026-02-23T07:58:38.874Z",
- "project_type": null,
- "template_version_id": "cd1228be-02d3-48a9-b031-91ecc73afcf6",
- "created_by": "elma.kovacek"
}, - "action_template_version": {
- "id": "cd1228be-02d3-48a9-b031-91ecc73afcf6",
- "commit_id": "8a690017-ae13-4a7e-9022-ef0e73131b57",
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "created_at": "2026-02-23T07:58:38.854Z",
- "updated_at": "2026-02-23T07:58:38.854Z",
- "state": "ready",
- "created_by": "leonida_kautzer",
- "archived": false,
- "has_mintmodel": true,
- "template_id": "8676d387-1f4b-4161-afdd-dd1cd5e0d257",
- "locked": false
}
}
], - "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "e2169991-af1f-49e8-878b-4d617fcf916e",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "3a7e679e-feb5-4f59-af8f-60628af597e7",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "roberto.stamm",
- "name": "assets workflow",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:39.441694Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:39.446594Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "225f3e87-29c2-4222-b986-f29b8c00003b",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501/steps/3a7e679e-feb5-4f59-af8f-60628af597e7",
- "log_lines": "/api/workflow_steps/3a7e679e-feb5-4f59-af8f-60628af597e7/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501"
}
}, - {
- "id": "225f3e87-29c2-4222-b986-f29b8c00003b",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "roberto.stamm",
- "name": "run asset action",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:39.449734Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:39.456192Z",
- "action": "run",
- "property_overrides": { }
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "51c39110-16ec-42ae-829b-55d6014a7ceb",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "cd1228be-02d3-48a9-b031-91ecc73afcf6",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501/steps/225f3e87-29c2-4222-b986-f29b8c00003b",
- "log_lines": "/api/workflow_steps/225f3e87-29c2-4222-b986-f29b8c00003b/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501/steps/3a7e679e-feb5-4f59-af8f-60628af597e7",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/0ed16fe6-d7ba-4ee6-8b40-fb88bc3a2501"
}
}
]
}Shows a workflow run.
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
{- "data": {
- "id": "99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "name": "excepturi",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "86f781d3-7aca-41d0-b2e1-7b4b8c41d554",
- "name": "facere",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "3bcd133a-f7e8-4365-9bd8-36740f19d750",
- "name": "back_up",
- "type": "workflow_change_step",
- "action": "back_up",
- "target": "/projects/enkvw/environments/04cqm/assets/qrc6a"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "2946f2be-ac3c-4ee0-9863-617573e96756",
- "name": "quantify",
- "type": "workflow_change_step",
- "action": "quantify",
- "target": "/projects/cggik/environments/er8xy/assets/nbdwo"
}, - {
- "id": "4946e59f-ea60-4bb2-8e3c-8ccd0741ef84",
- "name": "Wait",
- "type": "workflow_wait_step"
}, - {
- "id": "ac13964e-8a3f-4d0d-83ec-92fa2b3362e4",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/qlsna/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Alpha": "1.5.6",
- "Kanlam": "4.3.2",
- "Zoolab": "1.9.4",
- "Pannier": "0.66",
- "Prodder": "4.3",
- "Bytecard": "5.3",
- "Greenlam": "8.2.3",
- "Transcof": "8.68",
- "Tres-Zap": "0.98",
- "Toughjoyfax": "0.4.4"
}, - "created_by": "christel_jacobi",
- "cancelled_by": null,
- "status_code": "success",
- "created_at": "2026-02-23T07:58:40.974407Z",
- "started_at": "2026-02-23T07:53:27.241513Z",
- "finished_at": "2026-02-23T07:54:35.829954Z",
- "updated_at": "2026-02-23T07:58:40.986883Z",
- "project_name": "OpsChain"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "3605ade2-2f1a-49da-88b9-ce2c920be38a",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "b054a85d-3c20-47f6-81e0-6e77956e194e",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "2946f2be-ac3c-4ee0-9863-617573e96756",
- "type": "workflow_change_step"
}, - {
- "id": "4946e59f-ea60-4bb2-8e3c-8ccd0741ef84",
- "type": "workflow_wait_step"
}, - {
- "id": "ac13964e-8a3f-4d0d-83ec-92fa2b3362e4",
- "type": "workflow_workflow_step"
}, - {
- "id": "c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "type": "workflow_noop_step"
}, - {
- "id": "86f781d3-7aca-41d0-b2e1-7b4b8c41d554",
- "type": "workflow_noop_step"
}, - {
- "id": "3bcd133a-f7e8-4365-9bd8-36740f19d750",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "0afa3485-62a1-4b16-958e-093a17022ad5",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/0afa3485-62a1-4b16-958e-093a17022ad5"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "log_lines": "/api/workflow_runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/log_lines"
}, - "meta": {
- "parallel_workflows_allowed": false,
- "blocked_by_same_workflow_running": false,
- "blocked_by_queue": [ ]
}
}, - "included": [
- {
- "id": "3605ade2-2f1a-49da-88b9-ce2c920be38a",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "jae",
- "created_at": "2026-02-23T07:58:40.931449Z",
- "updated_at": "2026-02-23T07:58:40.944412Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "2098d204-5ba6-4100-8107-bb9dc120bcbf",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "2946f2be-ac3c-4ee0-9863-617573e96756",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "christel_jacobi",
- "name": "quantify",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 2,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:41.255869Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:41.264385Z",
- "action": "quantify",
- "property_overrides": {
- "pixel": "overriding"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "f976a742-f178-44ad-872c-808af52dddfc",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "34093b64-253e-40d2-a6de-b219f683bd41",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/2946f2be-ac3c-4ee0-9863-617573e96756",
- "log_lines": "/api/workflow_steps/2946f2be-ac3c-4ee0-9863-617573e96756/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db"
}
}, - {
- "id": "4946e59f-ea60-4bb2-8e3c-8ccd0741ef84",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "lock_version": 1,
- "created_by": "christel_jacobi",
- "name": "Wait",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 3,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:41.269631Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:41.275312Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/4946e59f-ea60-4bb2-8e3c-8ccd0741ef84",
- "log_lines": "/api/workflow_steps/4946e59f-ea60-4bb2-8e3c-8ccd0741ef84/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db"
}
}, - {
- "id": "ac13964e-8a3f-4d0d-83ec-92fa2b3362e4",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "christel_jacobi",
- "name": "child workflow",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 4,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:41.328954Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:41.336650Z",
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "35d36a8b-b699-47ce-acd3-3eea96f50f22",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": null
}, - "workflow_run": {
- "data": {
- "id": "99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/ac13964e-8a3f-4d0d-83ec-92fa2b3362e4",
- "log_lines": "/api/workflow_steps/ac13964e-8a3f-4d0d-83ec-92fa2b3362e4/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db"
}
}, - {
- "id": "c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "christel_jacobi",
- "name": "excepturi",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "success",
- "created_at": "2026-02-23T07:58:40.980445Z",
- "started_at": "2026-02-23T07:53:27.241513Z",
- "finished_at": "2026-02-23T07:54:35.829954Z",
- "updated_at": "2026-02-23T07:58:40.986883Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "86f781d3-7aca-41d0-b2e1-7b4b8c41d554",
- "type": "workflow_noop_step"
}, - {
- "id": "2946f2be-ac3c-4ee0-9863-617573e96756",
- "type": "workflow_change_step"
}, - {
- "id": "4946e59f-ea60-4bb2-8e3c-8ccd0741ef84",
- "type": "workflow_wait_step"
}, - {
- "id": "ac13964e-8a3f-4d0d-83ec-92fa2b3362e4",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "log_lines": "/api/workflow_steps/c69f6dd1-9d2f-4684-a698-5e039a3f5c79/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db"
}
}, - {
- "id": "86f781d3-7aca-41d0-b2e1-7b4b8c41d554",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 2,
- "created_by": "christel_jacobi",
- "name": "facere",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "running",
- "created_at": "2026-02-23T07:58:40.991315Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:41.128384Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "3bcd133a-f7e8-4365-9bd8-36740f19d750",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/86f781d3-7aca-41d0-b2e1-7b4b8c41d554",
- "log_lines": "/api/workflow_steps/86f781d3-7aca-41d0-b2e1-7b4b8c41d554/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/c69f6dd1-9d2f-4684-a698-5e039a3f5c79",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db"
}
}, - {
- "id": "3bcd133a-f7e8-4365-9bd8-36740f19d750",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "christel_jacobi",
- "name": "back_up",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:41.130686Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:41.138947Z",
- "action": "back_up",
- "property_overrides": {
- "program": "overriding"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "94fd9617-a29f-4781-9afd-0ad12677ef59",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "c6d6dbd8-170e-4268-b707-476e33372a1c",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "99f5437c-bc8f-486d-8d9c-bb9d1a7963db",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/3bcd133a-f7e8-4365-9bd8-36740f19d750",
- "log_lines": "/api/workflow_steps/3bcd133a-f7e8-4365-9bd8-36740f19d750/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db/steps/86f781d3-7aca-41d0-b2e1-7b4b8c41d554",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/99f5437c-bc8f-486d-8d9c-bb9d1a7963db"
}
}
]
}Cancels a workflow run.
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find WorkflowRun"
}
}
]
}Lists all runs for a workflow.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
{- "data": [
- {
- "id": "b98379b8-d95f-415e-bd9e-31570d5f8258",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "b801d39c-960f-44f6-9bb2-fe5e6c4dabae",
- "name": "et",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "0a86c291-0a55-4175-bfb9-a722564cc32f",
- "name": "necessitatibus",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "6a3f6546-4db9-46ae-9fab-da6ea79fb584",
- "name": "compress",
- "type": "workflow_change_step",
- "action": "compress",
- "target": "/projects/pvkyx/environments/dxzqn/assets/v0zok"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "2479fb07-6e2e-49f4-abea-0bb5fc6c7dcd",
- "name": "hack",
- "type": "workflow_change_step",
- "action": "hack",
- "target": "/projects/dhcth/environments/c4lqg/assets/1i0zl"
}, - {
- "id": "92eadeaa-1663-4304-9b85-69217f2f0bcf",
- "name": "Wait",
- "type": "workflow_wait_step"
}, - {
- "id": "1085b5e3-1655-4635-a69d-27cea44a3e42",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/tdpfr/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Viva": "0.21",
- "Namfix": "0.78",
- "Sub-Ex": "1.0",
- "Zoolab": "0.3.1",
- "Andalax": "0.8.6",
- "Matsoft": "1.57",
- "Flowdesk": "0.38",
- "Trippledex": "0.5.6",
- "Voltsillam": "0.6.2"
}, - "created_by": "cyril",
- "cancelled_by": null,
- "status_code": "success",
- "created_at": "2026-02-23T07:58:44.340999Z",
- "started_at": "2026-02-23T07:52:28.704304Z",
- "finished_at": "2026-02-23T07:54:10.684192Z",
- "updated_at": "2026-02-23T07:58:44.351278Z",
- "project_name": "OpsChain"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "af2e6a17-eab6-45f9-93f9-fd69988a3c2b",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "4eb62305-d7d4-434f-a8e8-9934d89a87ae",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "b801d39c-960f-44f6-9bb2-fe5e6c4dabae",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "0a86c291-0a55-4175-bfb9-a722564cc32f",
- "type": "workflow_noop_step"
}, - {
- "id": "6a3f6546-4db9-46ae-9fab-da6ea79fb584",
- "type": "workflow_change_step"
}, - {
- "id": "b801d39c-960f-44f6-9bb2-fe5e6c4dabae",
- "type": "workflow_noop_step"
}, - {
- "id": "2479fb07-6e2e-49f4-abea-0bb5fc6c7dcd",
- "type": "workflow_change_step"
}, - {
- "id": "92eadeaa-1663-4304-9b85-69217f2f0bcf",
- "type": "workflow_wait_step"
}, - {
- "id": "1085b5e3-1655-4635-a69d-27cea44a3e42",
- "type": "workflow_workflow_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "eca1cc98-67ed-4cc6-b422-c69543edc974",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/eca1cc98-67ed-4cc6-b422-c69543edc974"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/b98379b8-d95f-415e-bd9e-31570d5f8258",
- "log_lines": "/api/workflow_runs/b98379b8-d95f-415e-bd9e-31570d5f8258/log_lines"
}, - "meta": { }
}
], - "included": [
- {
- "id": "af2e6a17-eab6-45f9-93f9-fd69988a3c2b",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "joaquin",
- "created_at": "2026-02-23T07:58:44.300330Z",
- "updated_at": "2026-02-23T07:58:44.311669Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "5fe09993-f53c-4fe6-8b6e-9691ef59d9f9",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Runs a pre-defined workflow
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
required | object |
{- "data": {
- "attributes": {
- "version": 2,
- "property_overrides": {
- "additional": "properties"
}, - "metadata": {
- "optional": "metadata"
}
}
}
}{- "data": {
- "id": "cd883cc9-b0ed-4452-9075-5ce4455c3f57",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "5e7fbde8-2f58-47af-ac8c-b090630beb85",
- "name": "assets workflow",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "67466362-15e9-4ff8-85be-7e6ac2751cf6",
- "name": "run asset action",
- "type": "workflow_change_step",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": { },
- "created_by": "altha",
- "cancelled_by": null,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:46.034773Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:46.050505Z",
- "project_name": "OpsChain"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "98310338-7a18-4315-a62e-6c3f9322ff5c",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "21a822a7-5e54-491a-b6e3-bd807a9f81df",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "5e7fbde8-2f58-47af-ac8c-b090630beb85",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "67466362-15e9-4ff8-85be-7e6ac2751cf6",
- "type": "workflow_change_step"
}, - {
- "id": "5e7fbde8-2f58-47af-ac8c-b090630beb85",
- "type": "workflow_noop_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "321d9952-552c-410c-b082-cc306cdd1685",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/321d9952-552c-410c-b082-cc306cdd1685"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/cd883cc9-b0ed-4452-9075-5ce4455c3f57",
- "log_lines": "/api/workflow_runs/cd883cc9-b0ed-4452-9075-5ce4455c3f57/log_lines"
}, - "meta": { }
}, - "included": [
- {
- "id": "98310338-7a18-4315-a62e-6c3f9322ff5c",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "byron_dicki",
- "created_at": "2026-02-23T07:58:45.585099Z",
- "updated_at": "2026-02-23T07:58:45.599944Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa",
- "source": "steps/1",
- "change_parent": {
- "id": "560938d7-75fb-4ee2-b179-c761c4b5fa5e",
- "path": "/projects/opc/assets/prj_soa",
- "parent_path": "/projects/opc",
- "project_id": "c8d6b14f-84be-45aa-a77e-5254fa319537",
- "node_type": "asset",
- "parent_id": "c8d6b14f-84be-45aa-a77e-5254fa319537",
- "code": "prj_soa",
- "name": "Project asset",
- "description": "Project asset description",
- "archived": false,
- "created_at": "2026-02-23T07:58:45.498Z",
- "updated_at": "2026-02-23T07:58:45.498Z",
- "project_type": null,
- "template_version_id": "295958d8-67ac-4014-a940-70fa59bdc115",
- "created_by": "marvin.goldner"
}, - "action_template_version": {
- "id": "295958d8-67ac-4014-a940-70fa59bdc115",
- "commit_id": "beddbf32-ade2-4c13-8fb7-cd30bac55301",
- "version": "2023_Q4_2",
- "description": "Added additional configuration options",
- "created_at": "2026-02-23T07:58:45.478Z",
- "updated_at": "2026-02-23T07:58:45.478Z",
- "state": "ready",
- "created_by": "concepcion.oreilly",
- "archived": false,
- "has_mintmodel": true,
- "template_id": "9be4d3ce-2899-4358-bf93-cbffc4b33558",
- "locked": false
}
}
], - "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "c8d6b14f-84be-45aa-a77e-5254fa319537",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "67466362-15e9-4ff8-85be-7e6ac2751cf6",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "altha",
- "name": "run asset action",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:46.054125Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:46.060397Z",
- "action": "run",
- "property_overrides": { }
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "560938d7-75fb-4ee2-b179-c761c4b5fa5e",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "295958d8-67ac-4014-a940-70fa59bdc115",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "cd883cc9-b0ed-4452-9075-5ce4455c3f57",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/cd883cc9-b0ed-4452-9075-5ce4455c3f57/steps/67466362-15e9-4ff8-85be-7e6ac2751cf6",
- "log_lines": "/api/workflow_steps/67466362-15e9-4ff8-85be-7e6ac2751cf6/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/cd883cc9-b0ed-4452-9075-5ce4455c3f57/steps/5e7fbde8-2f58-47af-ac8c-b090630beb85",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/cd883cc9-b0ed-4452-9075-5ce4455c3f57"
}
}, - {
- "id": "5e7fbde8-2f58-47af-ac8c-b090630beb85",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "altha",
- "name": "assets workflow",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:46.043534Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:46.050505Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "cd883cc9-b0ed-4452-9075-5ce4455c3f57",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "67466362-15e9-4ff8-85be-7e6ac2751cf6",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/cd883cc9-b0ed-4452-9075-5ce4455c3f57/steps/5e7fbde8-2f58-47af-ac8c-b090630beb85",
- "log_lines": "/api/workflow_steps/5e7fbde8-2f58-47af-ac8c-b090630beb85/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/cd883cc9-b0ed-4452-9075-5ce4455c3f57",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/cd883cc9-b0ed-4452-9075-5ce4455c3f57"
}
}
]
}Shows a workflow run.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
{- "data": {
- "id": "aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "type": "workflow_run",
- "attributes": {
- "step_tree": {
- "id": "207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "name": "velit",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "39ad6d58-33bf-4402-a50b-7d26db77c7e7",
- "name": "et",
- "type": "workflow_noop_step",
- "children": [
- {
- "id": "13d80dbe-9e8c-4066-972c-c640e936a0fb",
- "name": "override",
- "type": "workflow_change_step",
- "action": "override",
- "target": "/projects/g0dlm/environments/ihrbj/assets/xtrtb"
}
], - "child_execution_strategy": "sequential"
}, - {
- "id": "61a165c3-9208-4950-a247-53968c296bfa",
- "name": "parse",
- "type": "workflow_change_step",
- "action": "parse",
- "target": "/projects/b1i9y/environments/oxnq6/assets/9pduw"
}, - {
- "id": "95ac24d7-3c83-4207-ac9d-71ad4a7bf747",
- "name": "Wait",
- "type": "workflow_wait_step"
}, - {
- "id": "892e0e69-3a81-406d-b069-94dc7357296d",
- "name": "child workflow",
- "type": "workflow_workflow_step",
- "target": "/projects/mqnh1/workflows/child"
}
], - "child_execution_strategy": "sequential"
}, - "scheduled": false,
- "metadata": {
- "Zoolab": "5.0",
- "Fix San": "0.1.0",
- "Konklab": "0.1.3",
- "Konklux": "0.27",
- "Redhold": "3.8.9",
- "Aerified": "3.1.8",
- "Flowdesk": "6.3.4",
- "Home Ing": "9.2.2",
- "Zaam-Dox": "0.6.4",
- "Holdlamis": "8.3"
}, - "created_by": "arthur",
- "cancelled_by": null,
- "status_code": "success",
- "created_at": "2026-02-23T07:58:48.244555Z",
- "started_at": "2026-02-23T07:50:10.646778Z",
- "finished_at": "2026-02-23T07:55:51.811370Z",
- "updated_at": "2026-02-23T07:58:48.256136Z",
- "project_name": "OpsChain"
}, - "relationships": {
- "workflow_version": {
- "data": {
- "id": "1452b40d-9155-4055-9408-0e59de6c4229",
- "type": "workflow_version"
}
}, - "workflow": {
- "data": {
- "id": "422c01fb-31c2-487b-bcca-42be04d58edc",
- "type": "workflow"
}
}, - "parent_workflow_step": {
- "data": null
}, - "root_step": {
- "data": {
- "id": "207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "type": "workflow_noop_step"
}
}, - "steps": {
- "data": [
- {
- "id": "61a165c3-9208-4950-a247-53968c296bfa",
- "type": "workflow_change_step"
}, - {
- "id": "95ac24d7-3c83-4207-ac9d-71ad4a7bf747",
- "type": "workflow_wait_step"
}, - {
- "id": "892e0e69-3a81-406d-b069-94dc7357296d",
- "type": "workflow_workflow_step"
}, - {
- "id": "207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "type": "workflow_noop_step"
}, - {
- "id": "39ad6d58-33bf-4402-a50b-7d26db77c7e7",
- "type": "workflow_noop_step"
}, - {
- "id": "13d80dbe-9e8c-4066-972c-c640e936a0fb",
- "type": "workflow_change_step"
}
]
}, - "override_properties": {
- "data": {
- "id": "5e5ebd1a-810d-40ee-a9ca-198be4d9cfdb",
- "type": "properties"
}, - "links": {
- "related": "/api/properties/5e5ebd1a-810d-40ee-a9ca-198be4d9cfdb"
}
}
}, - "links": {
- "parent": "/api/projects/opc",
- "self": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "log_lines": "/api/workflow_runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/log_lines"
}, - "meta": {
- "parallel_workflows_allowed": false,
- "blocked_by_same_workflow_running": false,
- "blocked_by_queue": [ ]
}
}, - "included": [
- {
- "id": "1452b40d-9155-4055-9408-0e59de6c4229",
- "type": "workflow_version",
- "attributes": {
- "code": "assets",
- "name": "assets workflow",
- "description": "workflow for assets",
- "draft": false,
- "archived": false,
- "created_by": "tasia.mccullough",
- "created_at": "2026-02-23T07:58:48.189718Z",
- "updated_at": "2026-02-23T07:58:48.203761Z",
- "source_yaml": "---\nsteps:\n- type: change\n name: run asset action\n target: \"/projects/opc/assets/prj_soa\"\n action: run\n",
- "steps": [
- {
- "name": "run asset action",
- "type": "change",
- "action": "run",
- "target": "/projects/opc/assets/prj_soa"
}
], - "resolved_steps": [ ],
- "sample_properties": {
- "sample": "value"
}, - "version": 2
}, - "relationships": {
- "parent": {
- "data": {
- "id": "e553bfbe-5e4e-4764-af80-51149eaf9c3e",
- "type": "project"
}, - "links": {
- "related": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/versions/2",
- "runs": "/api/projects/opc/workflows/assets/versions/2/runs",
- "workflow": "/api/projects/opc/workflows/assets"
}
}, - {
- "id": "61a165c3-9208-4950-a247-53968c296bfa",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "arthur",
- "name": "parse",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 2,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:48.648749Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:48.672461Z",
- "action": "parse",
- "property_overrides": {
- "matrix": "copying"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "88d32db5-29ac-4910-ad43-d9d5b43356fa",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "70149ae2-4138-4154-8e03-9d5ed5ec0c6c",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/61a165c3-9208-4950-a247-53968c296bfa",
- "log_lines": "/api/workflow_steps/61a165c3-9208-4950-a247-53968c296bfa/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb"
}
}, - {
- "id": "95ac24d7-3c83-4207-ac9d-71ad4a7bf747",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "lock_version": 1,
- "created_by": "arthur",
- "name": "Wait",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 3,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:48.693884Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:48.716746Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/95ac24d7-3c83-4207-ac9d-71ad4a7bf747",
- "log_lines": "/api/workflow_steps/95ac24d7-3c83-4207-ac9d-71ad4a7bf747/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb"
}
}, - {
- "id": "892e0e69-3a81-406d-b069-94dc7357296d",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "arthur",
- "name": "child workflow",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 4,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:48.821150Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:48.834311Z",
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "e2f4eb64-480f-47d4-a9db-17ba03593b91",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": null
}, - "workflow_run": {
- "data": {
- "id": "aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/892e0e69-3a81-406d-b069-94dc7357296d",
- "log_lines": "/api/workflow_steps/892e0e69-3a81-406d-b069-94dc7357296d/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb"
}
}, - {
- "id": "207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "arthur",
- "name": "velit",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "success",
- "created_at": "2026-02-23T07:58:48.250430Z",
- "started_at": "2026-02-23T07:50:10.646778Z",
- "finished_at": "2026-02-23T07:55:51.811370Z",
- "updated_at": "2026-02-23T07:58:48.256136Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "39ad6d58-33bf-4402-a50b-7d26db77c7e7",
- "type": "workflow_noop_step"
}, - {
- "id": "61a165c3-9208-4950-a247-53968c296bfa",
- "type": "workflow_change_step"
}, - {
- "id": "95ac24d7-3c83-4207-ac9d-71ad4a7bf747",
- "type": "workflow_wait_step"
}, - {
- "id": "892e0e69-3a81-406d-b069-94dc7357296d",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "log_lines": "/api/workflow_steps/207aa2e9-fe74-406d-9d5a-b95d63777a09/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb"
}
}, - {
- "id": "39ad6d58-33bf-4402-a50b-7d26db77c7e7",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 2,
- "created_by": "arthur",
- "name": "et",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "running",
- "created_at": "2026-02-23T07:58:48.259866Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:48.400181Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "13d80dbe-9e8c-4066-972c-c640e936a0fb",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/39ad6d58-33bf-4402-a50b-7d26db77c7e7",
- "log_lines": "/api/workflow_steps/39ad6d58-33bf-4402-a50b-7d26db77c7e7/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/207aa2e9-fe74-406d-9d5a-b95d63777a09",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb"
}
}, - {
- "id": "13d80dbe-9e8c-4066-972c-c640e936a0fb",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "arthur",
- "name": "override",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:48.402984Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:48.410803Z",
- "action": "override",
- "property_overrides": {
- "driver": "bypassing"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "6e94d870-4d00-4c54-ab26-8698e09765b9",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "0f85d441-ef63-42ea-bed7-3ba2d45bf1b4",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "aa4cf762-0ecb-40b5-bf41-c50e67a222fb",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/13d80dbe-9e8c-4066-972c-c640e936a0fb",
- "log_lines": "/api/workflow_steps/13d80dbe-9e8c-4066-972c-c640e936a0fb/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb/steps/39ad6d58-33bf-4402-a50b-7d26db77c7e7",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/aa4cf762-0ecb-40b5-bf41-c50e67a222fb"
}
}
]
}Cancels a workflow run.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find WorkflowRun"
}
}
]
}{- "data": [
- {
- "id": "a27c4322-47e7-461d-a940-214993a958e0",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "felisha",
- "name": "laudantium",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "success",
- "created_at": "2026-02-23T07:58:52.728270Z",
- "started_at": "2026-02-23T07:50:43.302455Z",
- "finished_at": "2026-02-23T07:53:19.939598Z",
- "updated_at": "2026-02-23T07:58:52.734897Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "b53885b4-6860-48f2-a7df-3c63ce4ac67d",
- "type": "workflow_noop_step"
}, - {
- "id": "8e7b5f52-38fd-4c49-bb23-ec0b64581225",
- "type": "workflow_change_step"
}, - {
- "id": "9b005c53-de71-4fa3-a894-e00b920b4aac",
- "type": "workflow_wait_step"
}, - {
- "id": "233afcad-5087-4e7d-8df6-9edae1f4ae85",
- "type": "workflow_workflow_step"
}, - {
- "id": "9e848c92-97f6-43b8-8c83-8c71e6cfbac3",
- "type": "workflow_change_step"
}, - {
- "id": "57d29a4e-b22f-46d9-b2c5-fb5e6a92648a",
- "type": "workflow_wait_step"
}, - {
- "id": "52640dfa-e83f-4967-ac25-c2cbc464f211",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/a27c4322-47e7-461d-a940-214993a958e0",
- "log_lines": "/api/workflow_steps/a27c4322-47e7-461d-a940-214993a958e0/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}, - {
- "id": "b53885b4-6860-48f2-a7df-3c63ce4ac67d",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 2,
- "created_by": "felisha",
- "name": "nisi",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "running",
- "created_at": "2026-02-23T07:58:52.740028Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:52.856671Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "3773a256-6c5f-45d1-87e2-d87d00837b69",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/b53885b4-6860-48f2-a7df-3c63ce4ac67d",
- "log_lines": "/api/workflow_steps/b53885b4-6860-48f2-a7df-3c63ce4ac67d/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/a27c4322-47e7-461d-a940-214993a958e0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}, - {
- "id": "8e7b5f52-38fd-4c49-bb23-ec0b64581225",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "felisha",
- "name": "quantify",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 2,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:52.984466Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:52.991888Z",
- "action": "quantify",
- "property_overrides": {
- "circuit": "overriding"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "fc1eb662-9616-44ce-9adc-d29da165098c",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "e4208267-77bc-4b17-b1ac-7f8e4e284558",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/8e7b5f52-38fd-4c49-bb23-ec0b64581225",
- "log_lines": "/api/workflow_steps/8e7b5f52-38fd-4c49-bb23-ec0b64581225/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/a27c4322-47e7-461d-a940-214993a958e0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}, - {
- "id": "9b005c53-de71-4fa3-a894-e00b920b4aac",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "lock_version": 1,
- "created_by": "felisha",
- "name": "Wait",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 3,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:52.997498Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:53.003932Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/9b005c53-de71-4fa3-a894-e00b920b4aac",
- "log_lines": "/api/workflow_steps/9b005c53-de71-4fa3-a894-e00b920b4aac/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/a27c4322-47e7-461d-a940-214993a958e0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}, - {
- "id": "233afcad-5087-4e7d-8df6-9edae1f4ae85",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "felisha",
- "name": "child workflow",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 4,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:53.060373Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:53.071494Z",
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "08dfe6a3-d66a-47ca-9826-259308b01403",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": null
}, - "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/233afcad-5087-4e7d-8df6-9edae1f4ae85",
- "log_lines": "/api/workflow_steps/233afcad-5087-4e7d-8df6-9edae1f4ae85/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/a27c4322-47e7-461d-a940-214993a958e0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}, - {
- "id": "9e848c92-97f6-43b8-8c83-8c71e6cfbac3",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "felisha",
- "name": "program",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 5,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:53.207751Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:53.215173Z",
- "action": "program",
- "property_overrides": {
- "array": "overriding"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "46d4fc40-34ab-437e-ac23-c9d272606f68",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "0b41f004-9b70-4e8d-b621-bd0f92681d34",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/9e848c92-97f6-43b8-8c83-8c71e6cfbac3",
- "log_lines": "/api/workflow_steps/9e848c92-97f6-43b8-8c83-8c71e6cfbac3/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/a27c4322-47e7-461d-a940-214993a958e0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}, - {
- "id": "57d29a4e-b22f-46d9-b2c5-fb5e6a92648a",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "lock_version": 1,
- "created_by": "felisha",
- "name": "Wait",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 6,
- "status_code": "continued",
- "created_at": "2026-02-23T07:52:37.267250Z",
- "started_at": "2026-02-23T07:53:37.267250Z",
- "finished_at": "2026-02-23T07:56:23.759248Z",
- "updated_at": "2026-02-23T07:58:53.228258Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/57d29a4e-b22f-46d9-b2c5-fb5e6a92648a",
- "log_lines": "/api/workflow_steps/57d29a4e-b22f-46d9-b2c5-fb5e6a92648a/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/a27c4322-47e7-461d-a940-214993a958e0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}, - {
- "id": "52640dfa-e83f-4967-ac25-c2cbc464f211",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "felisha",
- "name": "child workflow",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 7,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:53.234661Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:53.242466Z",
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "08dfe6a3-d66a-47ca-9826-259308b01403",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": null
}, - "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/52640dfa-e83f-4967-ac25-c2cbc464f211",
- "log_lines": "/api/workflow_steps/52640dfa-e83f-4967-ac25-c2cbc464f211/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/a27c4322-47e7-461d-a940-214993a958e0",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}, - {
- "id": "3773a256-6c5f-45d1-87e2-d87d00837b69",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "felisha",
- "name": "reboot",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "pending",
- "created_at": "2026-02-23T07:58:52.858929Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:58:52.865899Z",
- "action": "reboot",
- "property_overrides": {
- "monitor": "programming"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "d1d793af-3f44-447c-9287-672ba6c68b89",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "d2ed3f50-bd05-45ae-8c37-22e489e0f130",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "72aec16f-35b8-4969-b8c5-422efff07dc3",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/3773a256-6c5f-45d1-87e2-d87d00837b69",
- "log_lines": "/api/workflow_steps/3773a256-6c5f-45d1-87e2-d87d00837b69/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3/steps/b53885b4-6860-48f2-a7df-3c63ce4ac67d",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/72aec16f-35b8-4969-b8c5-422efff07dc3"
}
}
], - "meta": {
- "authorisations": {
- "update": false
}, - "partial_response": false
}
}Shows a workflow step.
| step_id required | string Example: 50997546-7320-4e05-9cb8-b874d6ac72c9 workflow step id |
{- "data": {
- "id": "961858eb-aaf6-4cd3-ad41-fa064ee4f67c",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "pedro",
- "name": "ipsam",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "success",
- "created_at": "2026-02-23T07:58:53.665550Z",
- "started_at": "2026-02-23T07:52:47.356067Z",
- "finished_at": "2026-02-23T07:56:15.239529Z",
- "updated_at": "2026-02-23T07:58:53.671068Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "31879f0a-8c1f-4040-b7f1-8101da160c89",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "e39688ac-e1ba-41a9-9d71-4523cc669cac",
- "type": "workflow_noop_step"
}, - {
- "id": "4b49f101-6914-43aa-97fc-9e00544611ed",
- "type": "workflow_change_step"
}, - {
- "id": "267fc5d1-bd41-4608-b3fa-37b6b4df779a",
- "type": "workflow_wait_step"
}, - {
- "id": "7f8a0711-9dfd-455e-8bc0-a8a1bd711d13",
- "type": "workflow_workflow_step"
}, - {
- "id": "0b44cb8d-98e9-43bf-a6f4-b6bb9456b615",
- "type": "workflow_change_step"
}, - {
- "id": "9cabc6e3-aaec-4ff7-842a-d3cccc84ab39",
- "type": "workflow_wait_step"
}, - {
- "id": "8cd40330-1887-47d7-80ab-d06a6babe754",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/31879f0a-8c1f-4040-b7f1-8101da160c89/steps/961858eb-aaf6-4cd3-ad41-fa064ee4f67c",
- "log_lines": "/api/workflow_steps/961858eb-aaf6-4cd3-ad41-fa064ee4f67c/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/31879f0a-8c1f-4040-b7f1-8101da160c89",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/31879f0a-8c1f-4040-b7f1-8101da160c89"
}
}
}Update a workflow step to flag it to be skipped on retry.
| step_id required | string Example: 50997546-7320-4e05-9cb8-b874d6ac72c9 workflow step id |
required | object |
{- "data": {
- "attributes": {
- "skip_on_retry": true
}
}
}{- "data": {
- "id": "1c8c7f56-a067-49aa-8533-4833c8217278",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 3,
- "created_by": "tobias.jacobs",
- "name": "navigate",
- "skip_on_retry": true,
- "notifications": { },
- "step_sequence": 5,
- "status_code": "error",
- "created_at": "2026-02-23T07:58:56.069792Z",
- "started_at": "2026-02-23T07:58:56.109937Z",
- "finished_at": "2026-02-23T07:59:56.109945Z",
- "updated_at": "2026-02-23T07:58:56.137558Z",
- "action": "navigate",
- "property_overrides": {
- "microchip": "programming"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "306a65a4-b56e-4e40-9664-7ff5a8e2179d",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "ba4b7305-4102-4e98-8a56-dd4eef330e45",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "a1920429-87b8-4528-a116-2d30f7197816",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/a1920429-87b8-4528-a116-2d30f7197816/steps/1c8c7f56-a067-49aa-8533-4833c8217278",
- "log_lines": "/api/workflow_steps/1c8c7f56-a067-49aa-8533-4833c8217278/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/a1920429-87b8-4528-a116-2d30f7197816/steps/3ed41e55-709d-4244-9d16-29140e46b109",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/a1920429-87b8-4528-a116-2d30f7197816"
}
}
}Continues a "waiting" workflow step. To approve/reject a workflow step that needs approval see the approve workflow step API endpoint.
| step_id required | string Example: f2fc5e34-3069-4605-8b15-0a9b30c2c1e6 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Done sanity checks. Ok to continue."
}
}
}{- "data": {
- "id": "0a98a7af-3165-4d0f-b8ab-57766c2b0015",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [
- {
- "username": "dewey.upton",
- "message": null
}
], - "requires_approval_from": null,
- "lock_version": 3,
- "created_by": "alan",
- "name": "Wait",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 8,
- "status_code": "continued",
- "created_at": "2026-02-23T07:51:05.890954Z",
- "started_at": "2026-02-23T07:52:05.890954Z",
- "finished_at": "2026-02-23T07:58:58.675429Z",
- "updated_at": "2026-02-23T07:58:58.697541Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "e7d85cbf-0ff0-4071-9258-6368cafe9da4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/e7d85cbf-0ff0-4071-9258-6368cafe9da4/steps/0a98a7af-3165-4d0f-b8ab-57766c2b0015",
- "log_lines": "/api/workflow_steps/0a98a7af-3165-4d0f-b8ab-57766c2b0015/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/e7d85cbf-0ff0-4071-9258-6368cafe9da4/steps/29f4d1c5-f84d-42a4-9110-1a0c399de277",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/e7d85cbf-0ff0-4071-9258-6368cafe9da4"
}
}
}Approve a workflow step that requires approval. To continue a workflow step that does need approval see the continue workflow step API endpoint
| step_id required | string Example: 1ae5c97e-c3fe-42b9-be2c-b1d7dd2b9a82 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Ok to proceed."
}
}
}{- "data": {
- "id": "8c8c28e2-b943-4880-b084-29dc030b10c9",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [
- {
- "username": "willetta",
- "message": null
}
], - "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": "an-ldap-group",
- "lock_version": 3,
- "created_by": "drew",
- "name": "Approval",
- "skip_on_retry": false,
- "notifications": {
- "on_approve": {
- "notify": true,
- "notify_to": {
- "via_email": "approvals@company.com"
}
}
}, - "step_sequence": 8,
- "status_code": "approved",
- "created_at": "2026-02-23T07:52:41.492275Z",
- "started_at": "2026-02-23T07:53:41.492275Z",
- "finished_at": "2026-02-23T07:59:01.612621Z",
- "updated_at": "2026-02-23T07:59:01.668869Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "9a181237-117c-45b4-b5dc-02a9e0c8aad0",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/9a181237-117c-45b4-b5dc-02a9e0c8aad0/steps/8c8c28e2-b943-4880-b084-29dc030b10c9",
- "log_lines": "/api/workflow_steps/8c8c28e2-b943-4880-b084-29dc030b10c9/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/9a181237-117c-45b4-b5dc-02a9e0c8aad0/steps/ab0d0561-58fc-435d-94bf-79f0cf82c41c",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/9a181237-117c-45b4-b5dc-02a9e0c8aad0"
}
}
}Reject a workflow step that requires approval.
| step_id required | string Example: 753f7da4-bc7c-4449-96cd-68b4f07cf535 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Ok to proceed."
}
}
}{- "data": {
- "id": "46edbb17-9050-47ad-ae03-119c9c24d87a",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [
- {
- "username": "austin_bogisich",
- "message": null
}
], - "continued_by": [ ],
- "requires_approval_from": "an-ldap-group",
- "lock_version": 3,
- "created_by": "elbert.macejkovic",
- "name": "Approval",
- "skip_on_retry": false,
- "notifications": {
- "on_approve": {
- "notify": true,
- "notify_to": {
- "via_email": "approvals@company.com"
}
}
}, - "step_sequence": 8,
- "status_code": "rejected",
- "created_at": "2026-02-23T07:49:24.841533Z",
- "started_at": "2026-02-23T07:50:24.841533Z",
- "finished_at": "2026-02-23T07:59:04.616787Z",
- "updated_at": "2026-02-23T07:59:04.621785Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "4ecce522-5f06-4067-a989-19c1fecf38f4",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/4ecce522-5f06-4067-a989-19c1fecf38f4/steps/46edbb17-9050-47ad-ae03-119c9c24d87a",
- "log_lines": "/api/workflow_steps/46edbb17-9050-47ad-ae03-119c9c24d87a/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/4ecce522-5f06-4067-a989-19c1fecf38f4/steps/9984eec6-a22f-489c-8944-5addf4a424f5",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/4ecce522-5f06-4067-a989-19c1fecf38f4"
}
}
}Lists all steps in a workflow run.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
{- "data": [
- {
- "id": "eed26ce3-9ffb-4a15-b823-118a74145023",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "gustavo.bosco",
- "name": "back_up",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "pending",
- "created_at": "2026-02-23T07:59:07.690010Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:59:07.695972Z",
- "action": "back_up",
- "property_overrides": {
- "hard drive": "programming"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "3501678d-ec6d-45a1-ad61-4ab28668f4c5",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "10aeaa06-82e9-48b8-9f55-a121e47dd4b9",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/eed26ce3-9ffb-4a15-b823-118a74145023",
- "log_lines": "/api/workflow_steps/eed26ce3-9ffb-4a15-b823-118a74145023/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/04dd6b7c-7bcd-4ce9-a979-383ebdc40c3b",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}, - {
- "id": "04dd6b7c-7bcd-4ce9-a979-383ebdc40c3b",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 2,
- "created_by": "gustavo.bosco",
- "name": "iusto",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "running",
- "created_at": "2026-02-23T07:59:07.587780Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:59:07.688112Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "eed26ce3-9ffb-4a15-b823-118a74145023",
- "type": "workflow_change_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/04dd6b7c-7bcd-4ce9-a979-383ebdc40c3b",
- "log_lines": "/api/workflow_steps/04dd6b7c-7bcd-4ce9-a979-383ebdc40c3b/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}, - {
- "id": "8d5eb36a-86c9-4b9b-ba41-777fb439ed3c",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "gustavo.bosco",
- "name": "program",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 2,
- "status_code": "pending",
- "created_at": "2026-02-23T07:59:07.789177Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:59:07.795300Z",
- "action": "program",
- "property_overrides": {
- "alarm": "synthesizing"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "dc6a1555-6e0f-40b8-b1cc-fe4da8fd42f7",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "5741f6fb-ab5c-45f0-9072-e86ce441680e",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/8d5eb36a-86c9-4b9b-ba41-777fb439ed3c",
- "log_lines": "/api/workflow_steps/8d5eb36a-86c9-4b9b-ba41-777fb439ed3c/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}, - {
- "id": "5c7a2604-4684-4d71-b46e-0465f8d573d4",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "lock_version": 1,
- "created_by": "gustavo.bosco",
- "name": "Wait",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 3,
- "status_code": "pending",
- "created_at": "2026-02-23T07:59:07.799850Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:59:07.805510Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/5c7a2604-4684-4d71-b46e-0465f8d573d4",
- "log_lines": "/api/workflow_steps/5c7a2604-4684-4d71-b46e-0465f8d573d4/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}, - {
- "id": "a4b15ea2-4402-4e61-92bd-1a02847dca6d",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "gustavo.bosco",
- "name": "child workflow",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 4,
- "status_code": "pending",
- "created_at": "2026-02-23T07:59:07.850296Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:59:07.856018Z",
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "407d15b2-d790-49d7-a437-b0b0afb6173d",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": null
}, - "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/a4b15ea2-4402-4e61-92bd-1a02847dca6d",
- "log_lines": "/api/workflow_steps/a4b15ea2-4402-4e61-92bd-1a02847dca6d/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}, - {
- "id": "961f7780-ebfb-468c-9fa8-a3434627e95c",
- "type": "workflow_change_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "gustavo.bosco",
- "name": "program",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 5,
- "status_code": "pending",
- "created_at": "2026-02-23T07:59:07.988942Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:59:07.995579Z",
- "action": "program",
- "property_overrides": {
- "program": "overriding"
}
}, - "relationships": {
- "change": {
- "data": null
}, - "change_parent": {
- "data": {
- "id": "acdc3ee5-7e04-455d-b3ec-34a612d3185c",
- "type": "asset"
}
}, - "action_template_version": {
- "data": {
- "id": "71de3ca3-7c88-46b1-8e94-fdf27f45ad88",
- "type": "template_version"
}
}, - "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/961f7780-ebfb-468c-9fa8-a3434627e95c",
- "log_lines": "/api/workflow_steps/961f7780-ebfb-468c-9fa8-a3434627e95c/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}, - {
- "id": "71cb139a-0a03-405d-aa39-f2b1ca1a3a00",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": null,
- "lock_version": 1,
- "created_by": "gustavo.bosco",
- "name": "Wait",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 6,
- "status_code": "continued",
- "created_at": "2026-02-23T07:48:08.593137Z",
- "started_at": "2026-02-23T07:49:08.593137Z",
- "finished_at": "2026-02-23T07:53:29.662402Z",
- "updated_at": "2026-02-23T07:59:08.009879Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/71cb139a-0a03-405d-aa39-f2b1ca1a3a00",
- "log_lines": "/api/workflow_steps/71cb139a-0a03-405d-aa39-f2b1ca1a3a00/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}, - {
- "id": "9cebdf9c-a44b-4bce-9664-082de6aeda1b",
- "type": "workflow_workflow_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "gustavo.bosco",
- "name": "child workflow",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 7,
- "status_code": "pending",
- "created_at": "2026-02-23T07:59:08.017746Z",
- "started_at": null,
- "finished_at": null,
- "updated_at": "2026-02-23T07:59:08.025368Z",
- "code": "child"
}, - "relationships": {
- "child_workflow_version": {
- "data": {
- "id": "407d15b2-d790-49d7-a437-b0b0afb6173d",
- "type": "workflow_version"
}
}, - "child_workflow_run": {
- "data": null
}, - "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/9cebdf9c-a44b-4bce-9664-082de6aeda1b",
- "log_lines": "/api/workflow_steps/9cebdf9c-a44b-4bce-9664-082de6aeda1b/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}, - {
- "id": "08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "gustavo.bosco",
- "name": "rerum",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "success",
- "created_at": "2026-02-23T07:59:07.580700Z",
- "started_at": "2026-02-23T07:50:32.933518Z",
- "finished_at": "2026-02-23T07:56:32.791757Z",
- "updated_at": "2026-02-23T07:59:07.584887Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "c659ee1d-4316-49bb-a26e-23a902527692",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "04dd6b7c-7bcd-4ce9-a979-383ebdc40c3b",
- "type": "workflow_noop_step"
}, - {
- "id": "8d5eb36a-86c9-4b9b-ba41-777fb439ed3c",
- "type": "workflow_change_step"
}, - {
- "id": "5c7a2604-4684-4d71-b46e-0465f8d573d4",
- "type": "workflow_wait_step"
}, - {
- "id": "a4b15ea2-4402-4e61-92bd-1a02847dca6d",
- "type": "workflow_workflow_step"
}, - {
- "id": "961f7780-ebfb-468c-9fa8-a3434627e95c",
- "type": "workflow_change_step"
}, - {
- "id": "71cb139a-0a03-405d-aa39-f2b1ca1a3a00",
- "type": "workflow_wait_step"
}, - {
- "id": "9cebdf9c-a44b-4bce-9664-082de6aeda1b",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692/steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9",
- "log_lines": "/api/workflow_steps/08a60d2e-9b8b-4db3-8405-c877a9765bd9/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c659ee1d-4316-49bb-a26e-23a902527692"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Shows a step of a workflow run.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
| step_id required | string Example: 50997546-7320-4e05-9cb8-b874d6ac72c9 workflow step id |
{- "data": {
- "id": "707384bb-fef9-4a7e-b25d-7b44ce45981b",
- "type": "workflow_noop_step",
- "attributes": {
- "lock_version": 1,
- "created_by": "linh.nikolaus",
- "name": "in",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 1,
- "status_code": "success",
- "created_at": "2026-02-23T07:59:09.003493Z",
- "started_at": "2026-02-23T07:51:25.722203Z",
- "finished_at": "2026-02-23T07:56:46.041347Z",
- "updated_at": "2026-02-23T07:59:09.008465Z",
- "child_execution_strategy": "sequential"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "c71eab21-8880-4fcd-be48-4a6b1698b107",
- "type": "workflow_run"
}
}, - "children": {
- "data": [
- {
- "id": "5913803e-283b-4a66-9394-fcd38f2b57e0",
- "type": "workflow_noop_step"
}, - {
- "id": "2ef5c5ca-0163-4749-8745-9365b323ac58",
- "type": "workflow_change_step"
}, - {
- "id": "d9eefe70-a9c3-4460-8678-62894bb79aa2",
- "type": "workflow_wait_step"
}, - {
- "id": "7b5eba2f-d1b5-4f83-8a18-4237b3c26463",
- "type": "workflow_workflow_step"
}, - {
- "id": "8cc9ecb4-cede-4355-872f-e9c75335dc1e",
- "type": "workflow_change_step"
}, - {
- "id": "e493d964-6956-4b8b-a184-459821f6ecad",
- "type": "workflow_wait_step"
}, - {
- "id": "c9d95e74-16f5-43cb-b20d-548319248aad",
- "type": "workflow_workflow_step"
}
]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/c71eab21-8880-4fcd-be48-4a6b1698b107/steps/707384bb-fef9-4a7e-b25d-7b44ce45981b",
- "log_lines": "/api/workflow_steps/707384bb-fef9-4a7e-b25d-7b44ce45981b/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/c71eab21-8880-4fcd-be48-4a6b1698b107",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/c71eab21-8880-4fcd-be48-4a6b1698b107"
}
}
}Continues a "waiting" workflow step. To approve/reject a workflow step that needs approval see the approve workflow step API endpoint.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
| step_id required | string Example: f2fc5e34-3069-4605-8b15-0a9b30c2c1e6 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Done sanity checks. Ok to continue."
}
}
}{- "data": {
- "id": "fe39a774-dc72-446d-a59e-4a468ded7ef0",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [ ],
- "continued_by": [
- {
- "username": "alexander.bergnaum",
- "message": null
}
], - "requires_approval_from": null,
- "lock_version": 3,
- "created_by": "derick",
- "name": "Wait",
- "skip_on_retry": false,
- "notifications": { },
- "step_sequence": 8,
- "status_code": "continued",
- "created_at": "2026-02-23T07:48:59.021547Z",
- "started_at": "2026-02-23T07:49:59.021547Z",
- "finished_at": "2026-02-23T07:59:12.092353Z",
- "updated_at": "2026-02-23T07:59:12.113531Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "d0d2dacb-079b-4b8c-a654-90b01bdd8cfb",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/d0d2dacb-079b-4b8c-a654-90b01bdd8cfb/steps/fe39a774-dc72-446d-a59e-4a468ded7ef0",
- "log_lines": "/api/workflow_steps/fe39a774-dc72-446d-a59e-4a468ded7ef0/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/d0d2dacb-079b-4b8c-a654-90b01bdd8cfb/steps/40c12404-0d2e-408f-9302-0aeaebb94489",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/d0d2dacb-079b-4b8c-a654-90b01bdd8cfb"
}
}
}Approve a workflow step that requires approval. To continue a workflow step that does need approval see the continue workflow step API endpoint
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
| step_id required | string Example: 1ae5c97e-c3fe-42b9-be2c-b1d7dd2b9a82 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Ok to proceed."
}
}
}{- "data": {
- "id": "a47d34c2-1841-4c89-857b-425316e91465",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [
- {
- "username": "kaitlin.powlowski",
- "message": null
}
], - "rejected_by": [ ],
- "continued_by": [ ],
- "requires_approval_from": "an-ldap-group",
- "lock_version": 3,
- "created_by": "kiara",
- "name": "Approval",
- "skip_on_retry": false,
- "notifications": {
- "on_approve": {
- "notify": true,
- "notify_to": {
- "via_email": "approvals@company.com"
}
}
}, - "step_sequence": 8,
- "status_code": "approved",
- "created_at": "2026-02-23T07:51:11.269957Z",
- "started_at": "2026-02-23T07:52:11.269957Z",
- "finished_at": "2026-02-23T07:59:14.319131Z",
- "updated_at": "2026-02-23T07:59:14.372734Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "9b46f74a-4f41-459e-98ab-59b8d1faeead",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/9b46f74a-4f41-459e-98ab-59b8d1faeead/steps/a47d34c2-1841-4c89-857b-425316e91465",
- "log_lines": "/api/workflow_steps/a47d34c2-1841-4c89-857b-425316e91465/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/9b46f74a-4f41-459e-98ab-59b8d1faeead/steps/3c598a3a-0ac0-433c-a50d-20de560ff2b3",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/9b46f74a-4f41-459e-98ab-59b8d1faeead"
}
}
}Reject a workflow step that requires approval.
| project_code required | string Example: opc project code |
| workflow_code required | string Example: assets workflow code |
| run_id required | string Example: 9a9bd6e9-8778-4b32-941a-14a5014c6869 workflow run id |
| step_id required | string Example: 753f7da4-bc7c-4449-96cd-68b4f07cf535 workflow step id |
object |
{- "data": {
- "attributes": {
- "message": "Ok to proceed."
}
}
}{- "data": {
- "id": "fd12def6-8d9e-4648-9587-54f37e2433f9",
- "type": "workflow_wait_step",
- "attributes": {
- "approved_by": [ ],
- "rejected_by": [
- {
- "username": "danilo",
- "message": null
}
], - "continued_by": [ ],
- "requires_approval_from": "an-ldap-group",
- "lock_version": 3,
- "created_by": "omar",
- "name": "Approval",
- "skip_on_retry": false,
- "notifications": {
- "on_approve": {
- "notify": true,
- "notify_to": {
- "via_email": "approvals@company.com"
}
}
}, - "step_sequence": 8,
- "status_code": "rejected",
- "created_at": "2026-02-23T07:48:39.817952Z",
- "started_at": "2026-02-23T07:49:39.817952Z",
- "finished_at": "2026-02-23T07:59:17.960675Z",
- "updated_at": "2026-02-23T07:59:17.967948Z"
}, - "relationships": {
- "workflow_run": {
- "data": {
- "id": "77f7dab2-9432-40cb-813a-e658ce16bf8c",
- "type": "workflow_run"
}
}, - "children": {
- "data": [ ]
}
}, - "links": {
- "self": "/api/projects/opc/workflows/assets/runs/77f7dab2-9432-40cb-813a-e658ce16bf8c/steps/fd12def6-8d9e-4648-9587-54f37e2433f9",
- "log_lines": "/api/workflow_steps/fd12def6-8d9e-4648-9587-54f37e2433f9/log_lines",
- "parent": "/api/projects/opc/workflows/assets/runs/77f7dab2-9432-40cb-813a-e658ce16bf8c/steps/6ab765e0-d106-421b-8362-ea1c925c1cc3",
- "workflow_run": "/api/projects/opc/workflows/assets/runs/77f7dab2-9432-40cb-813a-e658ce16bf8c"
}
}
}Endpoints to interact with events.
Lists all events.
| filter[<query/sort filter>]= | |
| limit | integer [ 1 .. 1000 ] Default: 10 Example: limit=50 Limit the number of events returned |
{- "data": [
- {
- "id": "778041b5-e624-49dd-8e61-364c7936d3fb",
- "type": "event",
- "attributes": {
- "nested": {
- "key": "nested value"
}, - "any_key": "with a value",
- "another_key": "with a different value",
- "username": "foster_hickle",
- "system": false,
- "type": "my custom event",
- "event_node_path": "/projects/opc",
- "created_at": "2026-02-23T07:57:57.623263Z"
}, - "relationships": {
- "source": {
- "links": {
- "source": "/api/projects/opc"
}, - "data": {
- "id": "d13b2728-7f40-47ef-bcba-d56a20687d22",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/events/778041b5-e624-49dd-8e61-364c7936d3fb"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false
}
}Creates an event.
required | object |
{- "data": {
- "attributes": {
- "type": "custom event",
- "any_key": "with a value",
- "another_key": "with a different value",
- "nested": {
- "key": "nested value"
}
}
}
}{- "data": {
- "id": "52b1409c-b7f7-4dd1-bbfd-1832ee5f0d41",
- "type": "event",
- "attributes": {
- "some": "event data",
- "username": "raymundo",
- "system": false,
- "type": "my event",
- "event_node_path": null,
- "created_at": "2026-02-23T07:57:57.920507Z"
}, - "relationships": {
- "source": {
- "links": {
- "source": null
}
}
}, - "links": {
- "self": "/api/events/52b1409c-b7f7-4dd1-bbfd-1832ee5f0d41"
}
}
}Shows an event.
| event_id required | string Example: 961f5713-930f-487a-97d8-379806cb1295 event id |
{- "data": {
- "id": "414cf1e9-4f0a-45bb-b533-44597c349c61",
- "type": "event",
- "attributes": {
- "nested": {
- "key": "nested value"
}, - "any_key": "with a value",
- "another_key": "with a different value",
- "username": "christi.abshire",
- "system": false,
- "type": "my custom event",
- "event_node_path": "/projects/opc",
- "created_at": "2026-02-23T07:57:58.247976Z"
}, - "relationships": {
- "source": {
- "links": {
- "source": "/api/projects/opc"
}, - "data": {
- "id": "e5ab3281-e7f0-4a0d-94ae-c245061aab0c",
- "type": "project"
}
}
}, - "links": {
- "self": "/api/events/414cf1e9-4f0a-45bb-b533-44597c349c61"
}
}
}Returns information about the jobs that are being processed by the OpsChain.
| filter[<query/sort filter>]= | |
| limit | integer [ 1 .. 1000 ] Default: 100 Example: limit=50 Limit the number of jobs returned |
{- "data": [
- {
- "id": "638023",
- "type": "job",
- "attributes": {
- "priority": 78,
- "job_class": "ChangeJob",
- "error_count": 0,
- "last_error_message": null,
- "queue": "default",
- "last_error_backtrace": null,
- "args": "[]",
- "data": "{}",
- "kwargs": "{}",
- "maximum_retry_count": 0,
- "node_id": "83db0b07-9716-40a2-a2b2-49a5ec4300ec",
- "node_path": "/projects/opc/environments/dev",
- "status": "finished",
- "worker_hostname": null,
- "description": "Verifies if a change can be started based on its owner configuration and, if so, starts it.",
- "run_at": "2026-02-23T04:31:40.837026Z",
- "finished_at": "2026-02-23T07:58:01.649594Z",
- "expired_at": null
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "partial_response": false,
- "has_any": true,
- "total_matching_filter": 1
}
}Endpoints to interact with settings.
Shows the current settings.
| settings_id required | string Example: fee961fc-6c5a-4dbe-be68-39cc56ceb7d0 settings id |
{- "data": {
- "id": "07a8499d-0344-4b2c-bcec-ac600a3096c5",
- "type": "settings",
- "attributes": {
- "data": {
- "requires_approval_from": "opschain",
- "repo_folder": ".opschain"
}, - "version": 1,
- "created_at": "2026-02-23T07:58:20.478069Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/settings/07a8499d-0344-4b2c-bcec-ac600a3096c5",
- "current_version": "/api/settings/07a8499d-0344-4b2c-bcec-ac600a3096c5/versions/1",
- "versions": "/api/settings/07a8499d-0344-4b2c-bcec-ac600a3096c5/versions"
}
}
}Updates a settings JSON if the included version matches the current settings version.
| id_to_update required | string Example: fee961fc-6c5a-4dbe-be68-39cc56ceb7d0 settings id |
required | object |
{- "data": {
- "attributes": {
- "data": {
- "requires_approval_from": "opschain",
- "repo_folder": ".opschain",
- "notifications": {
- "channels": [
- {
- "name": "slack-1",
- "type": "slack",
- "token": "slack-token"
}
]
}
}, - "version": 1
}
}
}{- "data": {
- "id": "ed177962-b192-4c9e-adba-41047b214439",
- "type": "settings",
- "attributes": {
- "data": {
- "requires_approval_from": "opschain",
- "repo_folder": ".opschain",
- "notifications": {
- "channels": [
- {
- "name": "slack-1",
- "type": "slack",
- "token": "{AES2}HZIqEF1wu5zG2lK14t/G2Q=={/IV}UuH132lwaXMJg469dMzATqg=="
}
]
}
}, - "version": 2,
- "created_at": "2026-02-23T07:58:20.782141Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/settings/ed177962-b192-4c9e-adba-41047b214439",
- "current_version": "/api/settings/ed177962-b192-4c9e-adba-41047b214439/versions/2",
- "versions": "/api/settings/ed177962-b192-4c9e-adba-41047b214439/versions"
}
}
}Updates a settings JSON, without any version checking (always updates).
| id_to_set required | string Example: fee961fc-6c5a-4dbe-be68-39cc56ceb7d0 settings id |
required | object |
{- "data": {
- "attributes": {
- "data": {
- "requires_approval_from": "opschain",
- "repo_folder": ".opschain",
- "notifications": {
- "channels": [
- {
- "name": "slack-1",
- "type": "slack",
- "token": "slack-token"
}
]
}
}
}
}
}{- "data": {
- "id": "4afd6a79-909b-4792-8ce7-37f89c70de34",
- "type": "settings",
- "attributes": {
- "data": {
- "requires_approval_from": "opschain",
- "repo_folder": ".opschain",
- "notifications": {
- "channels": [
- {
- "name": "slack-1",
- "type": "slack",
- "token": "{AES2}S0WSKDbJeWm9tFkg906e9w=={/IV}UhkViZLXJLYIFX3pU/OSqpQ=="
}
]
}
}, - "version": 2,
- "created_at": "2026-02-23T07:58:21.384541Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/projects/opc"
}
}
}, - "links": {
- "self": "/api/settings/4afd6a79-909b-4792-8ce7-37f89c70de34",
- "current_version": "/api/settings/4afd6a79-909b-4792-8ce7-37f89c70de34/versions/2",
- "versions": "/api/settings/4afd6a79-909b-4792-8ce7-37f89c70de34/versions"
}
}
}Endpoints to interact with the version history for settings.
Lists all versions of an OpsChain settings.
| settings_id required | string Example: fee961fc-6c5a-4dbe-be68-39cc56ceb7d0 settings id |
{- "data": [
- {
- "id": "ca956c4b-ff2c-4eab-91ab-9386a58f6b57",
- "type": "settings_version",
- "attributes": {
- "data": {
- "requires_approval_from": "opschain",
- "repo_folder": ".opschain"
}, - "version": 1,
- "created_at": "2026-02-23T07:58:21.816074Z"
}, - "relationships": {
- "settings": {
- "data": {
- "id": "5e0ef81f-e381-4dea-b2be-3b6be71a7269",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/5e0ef81f-e381-4dea-b2be-3b6be71a7269"
}
}
}, - "links": {
- "versions": "/api/settings/5e0ef81f-e381-4dea-b2be-3b6be71a7269/versions",
- "owner": "/api/projects/opc",
- "self": "/api/settings/5e0ef81f-e381-4dea-b2be-3b6be71a7269/versions/1"
}
}
]
}Shows the settings values for this settings version.
| settings_id required | string Example: fee961fc-6c5a-4dbe-be68-39cc56ceb7d0 settings id |
| version_number required | integer Example: 1 version number |
{- "data": {
- "id": "fba369e5-c827-41b1-a682-61a2c0aba840",
- "type": "settings_version",
- "attributes": {
- "data": {
- "requires_approval_from": "opschain",
- "repo_folder": ".opschain"
}, - "version": 1,
- "created_at": "2026-02-23T07:58:22.119226Z"
}, - "relationships": {
- "settings": {
- "data": {
- "id": "acaeaf14-3121-451c-b881-070c85ce5500",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/acaeaf14-3121-451c-b881-070c85ce5500"
}
}
}, - "links": {
- "versions": "/api/settings/acaeaf14-3121-451c-b881-070c85ce5500/versions",
- "owner": "/api/projects/opc",
- "self": "/api/settings/acaeaf14-3121-451c-b881-070c85ce5500/versions/1"
}
}
}{- "data": [
- {
- "id": "00e40dea-eca4-4a75-af5b-5ea499376d45",
- "type": "user",
- "attributes": {
- "username": "jody",
- "groupnames": [
- "ldap-group-1",
- "ldap-group-2"
], - "email_address": null,
- "auth_provider": "ldap",
- "created_at": "2026-02-23T07:58:34.521290Z",
- "updated_at": "2026-02-23T07:58:34.521290Z"
}
}
]
}Returns the decrypted values of the supplied secrets
required | object |
{- "data": {
- "attributes": {
- "owner_type": "settings",
- "owner_id": "2221003c-9208-4c2c-a38f-8c80f6940cff",
- "mintmodel_owner_path": "/projects/opc/assets/prj_soa",
- "converge_date": "2026-02-23T07:57:32.525280Z",
- "values_to_decrypt": [
- "secret-vault://csh/infrastructure/files/oci_platform_configs.yaml",
- "{AES2}TdxBDw3KtDj+FKKckKeF5A=={/IV}Ud/ubLWIwhpCwkgBa6DSd5A=="
]
}
}
}{- "data": {
- "id": "secrets",
- "type": "secrets",
- "attributes": {
- "results": [
- {
- "source": "secret-vault://csh/infrastructure/files/oci_platform_configs.yaml",
- "result": "ERROR: You do not have permission to resolve settings secrets for /projects/opc/environments/dev",
- "filename": null
}, - {
- "source": "secret-vault://csh/infrastructure/sshkeys/oci_new_key",
- "result": "ERROR: You do not have permission to resolve settings secrets for /projects/opc/environments/dev",
- "filename": null
}
]
}
}
}{- "data": {
- "id": "0",
- "type": "info",
- "attributes": {
- "version": "edge",
- "runner_image": "limepoint/opschain-runner-enterprise:edge",
- "db_version": "17.2",
- "api_version": "7.1.5.1",
- "ldap_available?": true,
- "banners": [ ],
- "instance_info": { },
- "licence_info": {
- "licence_issuer": "LimePoint Pty Ltd",
- "licence_issuer_contact": "support@limepoint.com",
- "licence_version": "1",
- "customer_identifier": "Engineering",
- "start_date": "2025-09-14T00:00:00Z",
- "end_date": "2026-09-14T00:00:00Z"
}
}, - "links": {
- "self": "/api/info"
}, - "meta": {
- "authorisations": {
- "secrets": {
- "global_decrypt": false,
- "global_encrypt": false
}
}
}
}
}{- "data": [
- {
- "id": "ca_self.pem",
- "type": "certificate",
- "attributes": {
- "filename": "ca_self.pem",
- "content": "-----BEGIN CERTIFICATE-----\nMIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL\nBQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l\nZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD\nDAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16\nSOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE\ngdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5\nRqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt\ndxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS\nGbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v\niNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28\nX8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH\nE+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf\n0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI\ndjd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW\nYlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV\nLjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD\nAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk\npjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX\nQKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0\nR8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW\nxerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk\nNDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15\nZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW\nhcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR\ntMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd\nesPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5\nAuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B\nWbrO/ELdag==\n-----END CERTIFICATE-----\n",
- "description": "Main CA cert.",
- "created_at": "2026-02-23T07:58:34.130576Z",
- "updated_at": "2026-02-23T07:58:34.130576Z"
}, - "links": {
- "self": "/api/trust_store/ca_self.pem"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}
}
}Creates a certificate in the trust store.
| description | string or null |
| file | string <binary> certificate file, the uploaded file's filename is used to name the new certificate |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="description" New certificate description ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file"; filename="remote_system.crt" content-type: application/x-x509-ca-cert content-length: 1887 -----BEGIN CERTIFICATE----- MIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL BQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l ZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD DAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ KoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16 SOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE gdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5 RqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt dxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS GbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v iNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28 X8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH E+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf 0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI djd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW YlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV LjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD AQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk pjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX QKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0 R8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW xerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk NDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15 ZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW hcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR tMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd esPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5 AuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B WbrO/ELdag== -----END CERTIFICATE----- ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "remote_system.crt",
- "type": "certificate",
- "attributes": {
- "filename": "remote_system.crt",
- "content": "-----BEGIN CERTIFICATE-----\nMIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL\nBQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l\nZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD\nDAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16\nSOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE\ngdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5\nRqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt\ndxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS\nGbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v\niNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28\nX8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH\nE+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf\n0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI\ndjd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW\nYlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV\nLjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD\nAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk\npjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX\nQKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0\nR8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW\nxerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk\nNDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15\nZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW\nhcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR\ntMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd\nesPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5\nAuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B\nWbrO/ELdag==\n-----END CERTIFICATE-----\n",
- "description": "New certificate description",
- "created_at": "2026-02-23T07:58:34.184687Z",
- "updated_at": "2026-02-23T07:58:34.184687Z"
}, - "links": {
- "self": "/api/trust_store/remote_system.crt"
}
}
}Shows a certificate from the trust store.
| certificate_filename required | string Example: ca_self.pem certificate filename |
{- "data": {
- "id": "ca_self.pem",
- "type": "certificate",
- "attributes": {
- "filename": "ca_self.pem",
- "content": "-----BEGIN CERTIFICATE-----\nMIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL\nBQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l\nZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD\nDAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16\nSOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE\ngdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5\nRqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt\ndxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS\nGbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v\niNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28\nX8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH\nE+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf\n0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI\ndjd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW\nYlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV\nLjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD\nAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk\npjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX\nQKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0\nR8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW\nxerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk\nNDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15\nZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW\nhcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR\ntMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd\nesPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5\nAuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B\nWbrO/ELdag==\n-----END CERTIFICATE-----\n",
- "description": "Main CA cert.",
- "created_at": "2026-02-23T07:58:34.219014Z",
- "updated_at": "2026-02-23T07:58:34.219014Z"
}, - "links": {
- "self": "/api/trust_store/ca_self.pem"
}
}
}Delete certificate from the trust store.
| certificate_filename required | string Example: ca_self.pem certificate filename |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find Certificate"
}
}
]
}Updates a certificate in the trust store.
| certificate_filename required | string Example: ca_self.pem certificate filename |
| description | string or null |
| file | string <binary> certificate file (the filename is ignored) |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="description" Updated certificate description ------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="file"; filename="remote_system.crt" content-type: application/x-x509-ca-cert content-length: 1887 -----BEGIN CERTIFICATE----- MIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL BQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l ZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD DAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ KoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16 SOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE gdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5 RqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt dxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS GbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v iNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28 X8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH E+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf 0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI djd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW YlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV LjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD AQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk pjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX QKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0 R8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW xerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk NDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15 ZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW hcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR tMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd esPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5 AuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B WbrO/ELdag== -----END CERTIFICATE----- ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "remote_system.crt",
- "type": "certificate",
- "attributes": {
- "filename": "remote_system.crt",
- "content": "-----BEGIN CERTIFICATE-----\nMIIFQzCCAyugAwIBAgIUeNS0f9lqaJhC2apc91FbPRBVPNwwDQYJKoZIhvcNAQEL\nBQAwMTEQMA4GA1UEAwwHUm9vdCBDQTEdMBsGA1UECgwUTGltZVBvaW50RW5naW5l\nZXJpbmcwHhcNMjUwNDI5MDA0NzAxWhcNMzAwNDI5MDA0NzAxWjAxMRAwDgYDVQQD\nDAdSb290IENBMR0wGwYDVQQKDBRMaW1lUG9pbnRFbmdpbmVlcmluZzCCAiIwDQYJ\nKoZIhvcNAQEBBQADggIPADCCAgoCggIBAJoUxJkyK3VKbBhVwQPRmA9MqUOocn16\nSOZm5KVPVyR2F9OZ4xIyZTkUalUFGrguoDAyvKAI+AgGRhNJG+kKQ7PLAAEbSWBE\ngdXNNtSAj4Yvo0Bw3XbxqZM7kBO7GfysKMjqKsEeR0wiwshAQPsBjAYa78ayDRC5\nRqN1jR9al65UdLcE5yDbbpMd7GwR3b9ythahsox8PfHL60sZf7NfI4q+SkgbOVzt\ndxppCZqwZRuMVWdvvQk069UkOYoRXniQEIFU6Ugd8FWIIzleHyKEodTsRhhXUjBS\nGbA3v+x66mS87r6bE6ffFwLO0reFgfx4a7dMmhd5djrOfZtZ0L8zizXwsyee5j6v\niNokciyLHgRfWYHsYZ3OgHC8p7i02Xd9vcCsaPuoGopo0G/+wog289ObTqGbxu28\nX8Bk5/kIVkn79LDA4zWz7VwYY0uoK0TxWpdMg2yuvE5nH94qGlnJisopxVhrZ7qH\nE+QEqUYhelJNCi62Z8gmT0z3d7lmsq9gH23o1Zngdhnygdrm3rh404bjK/xFL6Hf\n0YmiYhQw8ydHKGWY8rfhjL8eXl1gURZTqLTZC6J3sF3SAS1hj2nrePsPGt7S1OqI\ndjd/vGLSLz/SGyE9d5sOeTvza9pmKKXKqcvPFbwgF496dZmAu6xtVC+6pa8hOXJW\nYlC0xn/xXnTFAgMBAAGjUzBRMB0GA1UdDgQWBBRdN8nNGCxpxe0zHXz3BrrtlYvV\nLjAfBgNVHSMEGDAWgBRdN8nNGCxpxe0zHXz3BrrtlYvVLjAPBgNVHRMBAf8EBTAD\nAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQB6jtlLzWd6yjbye2SsB04ns6B6WskdOAkk\npjGz7MyARCEvgfHh5HtMzBi9l5mxXjMfYuQx3ag75lTSaA/OUgGCQOQygwD6qUXX\nQKslqCh1EEbNfDUuBt31OhAFECkKl194euhuIjUugyL+D07Oscg+k77WDEesBif0\nR8ei+j+AX/sK4RFacFMgAAWHaI3chGu2qrnFHoKEB/R9OUieEb6c8CbVEXyOzCbW\nxerP1sxPBuqvw5/UMwdafXlVmPfC/7C1dJzdw5/yAE6gwEB0ztaaEMsA22smd8dk\nNDugbmY9yTLRWFN2XIs9jgCaDM0hZOFDPbxkX7oD30z3FVkbuSII3EK0GAqHYy15\nZLD5xaxolyKOvQwXYoHVJD95KX1OVuNcILsd2iVGAKpI8IWOu2A1Kvq/Kr5qtxRW\nhcP+nL5XVu/mGP/GABI/zggORdjfAezb9mWi2ozfmSHyJsN8qfVOvK4urDj2YdbR\ntMybK+X7KpN947oZQwJ8WgfO3mTt4jkYPEFgUyVDFRuMcx25ewxy/5+HcpZvgmKd\nesPTYnR/q+kdQ+IO2OrOoBGUJ8F7bmiAKVThBWZKUn9jGAym+A4CEMrklCYwqZT5\nAuA0rI1AjitrP74YqylXtmP2IUJkxCOXBthnlt1oC2UPYXyACPdp5K4+KZbK/63B\nWbrO/ELdag==\n-----END CERTIFICATE-----\n",
- "description": "Updated certificate description",
- "created_at": "2026-02-23T07:58:34.485780Z",
- "updated_at": "2026-02-23T07:58:34.485780Z"
}, - "links": {
- "self": "/api/trust_store/remote_system.crt"
}
}
}Updates the system licence.
| licence | string |
------------XnJLe9ZIbbGUYtzPQJ16u1 content-disposition: form-data; name="licence"; filename="expired_opschain.licence" content-type: application/json content-length: 924 {"data":{"license_issuer":"LimePoint Pty Ltd","license_issuer_contact":"support@limepoint.com","license_version":"1","customer_identifier":"Engineering","start_date":"2023-11-14T00:00:00Z","end_date":"2024-02-14T00:00:00Z"},"signature":"m/hevqjjrYYjOS8ZtgVGGerm028UpKWw/I1cGB4vcJCwI805OtAo1PmszCxWQGOXilgAqyLERLluimRBckFYVL8yx7+rTFxF4D13FqwbwRL5HcKKkV1wwGgzuMpaGE8JGpAq/CkBq6l3xL+jPv/CSYaEyE55+20UdmkZdkvR2vKoJtqDzA1q/4T9tiPA0YIKDjjxSasLBpqokl0iUuaDWksaIhXjdsKmj0FSPfVD2VyPyrBSc1sv0pR+qz98Ny9ef7t6/pIaphLo8Yaa2dnJykeXtAWiaLe+25/OWxEHZoZBvKjentD5dzvqiA8Xo1qhm/tMurTQq4BGJvWYK70LQY9EXlxd+1XLbFX0qdNBNFnzf+rjbGfrLIMw2NFhsODDordSh5P3xNGGG4JyXrwXVRPUaw30celB+uYK3vvDzis0DSBXSA+D9JV3E9YxbI4xuT9Kf+bl0+cr/BajEBhuzATk30a8y5Zqn2MfCBmMb1iLkoFWWvFA+cfUsKsWk3O4YDmR3paOz+HVrSA5HlwaOMOU/P15/q5YFfN6ZEz4DW28I+lfFE3PtgkCsjcPCd99Ca4ZSmiok/l55zRxxrYl6Xc1TNOuq58yp05U798VaEEvmCaVvp5Fk/+TrbGMWKUlPPvc86RzsOlI8Qkdn75SJM3WMEl931m4A52g6jF6+T0="} ------------XnJLe9ZIbbGUYtzPQJ16u1--
{- "data": {
- "id": "expired_opschain.licence",
- "type": "licence",
- "attributes": {
- "licence": "licence data"
}
}
}Shows the current system configuration node.
| include | string Example: include=settings Include the settings in the response |
{- "data": {
- "id": "b5affe6e-1fe0-4d70-a2bc-d30a29318585",
- "type": "system_configuration",
- "attributes": {
- "code": "system",
- "name": "System Configuration",
- "description": "System configuration node"
}, - "relationships": {
- "settings": {
- "data": {
- "id": "7e846caf-7c70-4548-851b-5aa0b0095def",
- "type": "settings"
}, - "links": {
- "related": "/api/settings/7e846caf-7c70-4548-851b-5aa0b0095def"
}
}
}, - "links": {
- "self": "/api/system_configuration",
- "settings": "/api/settings/7e846caf-7c70-4548-851b-5aa0b0095def"
}, - "meta": {
- "can_have_changes": false,
- "can_have_children": false,
- "can_have_properties": false,
- "can_have_settings": true,
- "can_have_templates": false,
- "requires_template": false,
- "child_node_types": [ ],
- "can_have_workflows": false,
- "authorisations": {
- "settings": {
- "read": true,
- "update": true
}, - "self": {
- "update": true
}
}
}
}, - "included": [
- {
- "id": "7e846caf-7c70-4548-851b-5aa0b0095def",
- "type": "settings",
- "attributes": {
- "data": {
- "allow_parallel": {
- "changes": true,
- "runs_of_same_change": false,
- "runs_of_same_workflow": false
}, - "api": {
- "external_port": 3000
}, - "auth_strategy": "ldap",
- "product_name": "OpsChain",
- "rails": {
- "env": "test",
- "log_level": "info",
- "max_threads": 5
}, - "server_timing": false,
- "build_service": {
- "host": "opschain-build-service",
- "port": 50000
}, - "github": {
- "token": "{AES2}JHtP20S8JVPEM5M7j0RPQA=={/IV}UhQee1wkuK6lbRFxAD3IMLg==",
- "user": "{AES2}epDJ7xifCKdyVe4vh10rsg=={/IV}U6DYYXSt5hE76KqdlHhd1tw=="
}, - "docker": {
- "password": "{AES2}uxsvrOu6gTNTbPOeJEaZuQ=={/IV}UYjdgPRkYaFAaqpU9R20yEA==",
- "user": "{AES2}cMG+4Wo43VHvOdHPa0PCdA=={/IV}UHkCxUc1qHlbOlL8ZfZIVug=="
}, - "image_pull_secret": "opschain-image-secret",
- "image_registry": {
- "host": "opschain-image-registry.local.gd",
- "internal_host": "opschain-image-registry",
- "password": "{AES2}sYpfJii+v+TH47ShuiRo8Q=={/IV}UYNp2kbGzvav4b9iXI7dayw==",
- "user": "{AES2}joMXDChYJJ5+CGhLHikVNw=={/IV}Uat96QGIlqL3lY2C0r5sNyw=="
}, - "log_step_pod_events": false,
- "agent": {
- "repository": "limepoint",
- "name": "opschain-runner",
- "image_tag": "local",
- "node_selector": "{}",
- "script_path": "/opt/opschain/agent.sh"
}, - "runner": {
- "repository": "limepoint",
- "name": "opschain-runner-enterprise",
- "image_tag": "local",
- "node_selector": "{}"
}, - "worker": {
- "repository": "limepoint",
- "name": "opschain-mintmodel-executor",
- "image_tag": "local"
}, - "mintmodel_executor": {
- "repository": "limepoint",
- "name": "opschain-mintmodel-executor",
- "image_tag": "local"
}, - "parallel_change_worker_steps": 5,
- "requires_approval_from": "",
- "gui_base_url": "",
- "ingress_tls_port": 443,
- "ldap": {
- "cache_ttl": 60,
- "domain": "opschain.io",
- "hc_user": "healthcheck",
- "enable_ssl": false,
- "host": "opschain-ldap",
- "port": 389,
- "password": "{AES2}laCqCIqjGpl5XDQb86E94w=={/IV}UodWBEWU310/+4W/p8uP3bg==",
- "mail_attribute": "mail",
- "use_admin_to_bind": true,
- "groups_filter": "(objectClass=groupOfNames)",
- "users_filter": "(objectClass=inetOrgPerson)",
- "new_group_object_class": [
- "groupOfNames"
], - "new_user_object_class": [
- "inetOrgPerson",
- "top"
], - "new_org_unit_object_class": [
- "organizationalUnit",
- "top"
], - "log_level": 1024,
- "logging_enabled": true,
- "admin": "cn=admin,dc=opschain,dc=io",
- "base_dn": "dc=opschain,dc=io",
- "group_attribute": "member",
- "group_base": "ou=groups,dc=opschain,dc=io",
- "organisation": "OpsChain",
- "user_attribute": "uid",
- "user_base": "ou=test,dc=opschain,dc=io"
}, - "licence": "",
- "log_aggregator_additional_output_settings": "",
- "kubernetes_namespace": "opschain",
- "notifications": {
- "channels": [ ],
- "events": {
- "change": { },
- "workflow_run": { }
}
}, - "notifications_base_url": "",
- "pod_per_change_step": false,
- "repo_folder": ".opschain",
- "threads_per_worker": 5,
- "tz": "Australia/Melbourne",
- "vault": {
- "use_default_vault": true
}, - "version": "local"
}, - "version": 1,
- "created_at": "2026-02-23T07:58:30.425732Z"
}, - "relationships": {
- "owner": {
- "links": {
- "owner": "/api/system_configuration"
}
}
}, - "links": {
- "self": "/api/settings/7e846caf-7c70-4548-851b-5aa0b0095def",
- "current_version": "/api/settings/7e846caf-7c70-4548-851b-5aa0b0095def/versions/1",
- "versions": "/api/settings/7e846caf-7c70-4548-851b-5aa0b0095def/versions"
}
}
]
}Returns status information about the OpsChain database.
{- "data": [
- {
- "id": "0",
- "type": "database_status",
- "attributes": {
- "version": "17.5",
- "uptime": 756,
- "database_size": "11 MB",
- "connections": {
- "active": 1,
- "idle": 2,
- "max_configured": 100
}, - "connection_settings": {
- "pgdb": "opschain",
- "pghost": "opschain-db",
- "pgport": 5432
}, - "table_sizes": [
- {
- "name": "policy_assignments",
- "size": "96 kB"
}, - {
- "name": "que_jobs",
- "size": "96 kB"
}, - {
- "name": "nodes",
- "size": "88 kB"
}, - {
- "name": "policy_rules",
- "size": "80 kB"
}, - {
- "name": "workflow_steps",
- "size": "80 kB"
}, - {
- "name": "solid_cache_entries",
- "size": "80 kB"
}, - {
- "name": "authorisation_rules",
- "size": "72 kB"
}, - {
- "name": "steps",
- "size": "72 kB"
}, - {
- "name": "scheduled_activities",
- "size": "64 kB"
}, - {
- "name": "schema_migrations",
- "size": "64 kB"
}, - {
- "name": "changes",
- "size": "64 kB"
}, - {
- "name": "users",
- "size": "64 kB"
}, - {
- "name": "events",
- "size": "56 kB"
}, - {
- "name": "templates",
- "size": "48 kB"
}, - {
- "name": "node_background_tasks",
- "size": "48 kB"
}, - {
- "name": "template_version_history",
- "size": "48 kB"
}, - {
- "name": "authorisation_policies",
- "size": "48 kB"
}, - {
- "name": "asset_mintmodel_actions",
- "size": "40 kB"
}, - {
- "name": "log_lines",
- "size": "40 kB"
}, - {
- "name": "mintmodel_history",
- "size": "40 kB"
}, - {
- "name": "que_job_history",
- "size": "40 kB"
}, - {
- "name": "que_scheduler_audit_enqueued",
- "size": "40 kB"
}, - {
- "name": "ar_internal_metadata",
- "size": "32 kB"
}, - {
- "name": "step_properties_versions",
- "size": "32 kB"
}, - {
- "name": "bookmarks",
- "size": "32 kB"
}, - {
- "name": "workflow_versions",
- "size": "32 kB"
}, - {
- "name": "que_lockers",
- "size": "32 kB"
}, - {
- "name": "que_job_worker_hostname",
- "size": "32 kB"
}, - {
- "name": "commits",
- "size": "32 kB"
}, - {
- "name": "agent_statuses",
- "size": "24 kB"
}, - {
- "name": "properties",
- "size": "24 kB"
}, - {
- "name": "settings_versions",
- "size": "24 kB"
}, - {
- "name": "git_remotes",
- "size": "24 kB"
}, - {
- "name": "settings",
- "size": "24 kB"
}, - {
- "name": "template_versions",
- "size": "24 kB"
}, - {
- "name": "step_status_events",
- "size": "24 kB"
}, - {
- "name": "properties_versions",
- "size": "24 kB"
}, - {
- "name": "workflow_runs",
- "size": "24 kB"
}, - {
- "name": "certificates",
- "size": "24 kB"
}, - {
- "name": "workflows",
- "size": "24 kB"
}, - {
- "name": "mintmodels",
- "size": "24 kB"
}, - {
- "name": "que_values",
- "size": "16 kB"
}, - {
- "name": "mintmodel_actions",
- "size": "16 kB"
}, - {
- "name": "data_cleanup_definitions",
- "size": "16 kB"
}, - {
- "name": "que_scheduler_audit",
- "size": "8192 bytes"
}, - {
- "name": "log_lines_incoming",
- "size": "0 bytes"
}, - {
- "name": "que_live_jobs",
- "size": "0 bytes"
}, - {
- "name": "queued_que_jobs",
- "size": "0 bytes"
}, - {
- "name": "queued_mintmodel_step_jobs",
- "size": "0 bytes"
}, - {
- "name": "queued_step_jobs",
- "size": "0 bytes"
}, - {
- "name": "scheduled_activity_que_jobs",
- "size": "0 bytes"
}, - {
- "name": "data_cleanup_definition_que_jobs",
- "size": "0 bytes"
}, - {
- "name": "change_activities",
- "size": "0 bytes"
}, - {
- "name": "workflow_run_activities",
- "size": "0 bytes"
}, - {
- "name": "change_parents",
- "size": "0 bytes"
}, - {
- "name": "node_background_task_que_jobs",
- "size": "0 bytes"
}, - {
- "name": "jobs",
- "size": "0 bytes"
}
]
}, - "links": {
- "self": "/api/admin/database"
}
}
]
}{- "data": [
- {
- "id": "opschain.limepoint.engineering",
- "type": "node_status",
- "attributes": {
- "name": "opschain.limepoint.engineering",
- "creation_timestamp": "2024-03-05T00:03:56Z",
- "kubelet_version": "v1.29.6+k3s2",
- "container_runtime_version": "docker://24.0.2",
- "os": "linux",
- "os_image": "Fedora Linux 36 (Server Edition)",
- "architecture": "amd64",
- "roles": [
- "control-plane",
- "master"
], - "metrics": {
- "cpu": "100m",
- "memory": "100Mi"
}, - "conditions": [
- {
- "type": "MemoryPressure",
- "status": "False",
- "reason": "KubeletHasSufficientMemory",
- "message": "kubelet has sufficient memory available",
- "last_heartbeat_time": "2025-01-01T00:00:00Z",
- "last_transition_time": "2024-09-30T12:00:00Z"
}, - {
- "type": "DiskPressure",
- "status": "False",
- "reason": "KubeletHasNoDiskPressure",
- "message": "kubelet has no disk pressure",
- "last_heartbeat_time": "2025-01-01T00:00:00Z",
- "last_transition_time": "2024-09-30T12:00:00Z"
}, - {
- "type": "PIDPressure",
- "status": "False",
- "reason": "KubeletHasSufficientPID",
- "message": "kubelet has sufficient PID available",
- "last_heartbeat_time": "2025-01-01T00:00:00Z",
- "last_transition_time": "2024-09-30T12:00:00Z"
}, - {
- "type": "Ready",
- "status": "True",
- "reason": "KubeletReady",
- "message": "kubelet is posting ready status",
- "last_heartbeat_time": "2025-01-01T00:00:00Z",
- "last_transition_time": "2024-09-30T12:00:00Z"
}
], - "capacity": {
- "cpu": "16",
- "memory": "131907404Ki",
- "pods": "110",
- "ephemeral_storage": "103757316Ki"
}, - "allocatable": {
- "cpu": "16",
- "memory": "131907404Ki",
- "pods": "110",
- "ephemeral_storage": "100935116926"
}, - "images": [
- {
- "names": [
- "registry.local.gd:3443/opschain/runner@sha256:256",
- "registry.local.gd:3443/opschain/runner:01234-id"
], - "size_bytes": 2615498231
}
]
}
}
]
}Returns the status of the OpsChain queues and details about their jobs.
{- "data": [
- {
- "id": "default",
- "type": "queue_status",
- "attributes": {
- "name": "default",
- "summary": {
- "total": 10,
- "running": 2,
- "failed": 1,
- "scheduled": 3,
- "finished": 4,
- "pending": 1
}, - "jobs": [
- {
- "job_class": "ChangeJob",
- "total": 5,
- "running": 1,
- "failed": 1,
- "scheduled": 2,
- "finished": 3,
- "pending": 0,
- "next_run_at": "2026-02-23T19:57:38.418+11:00",
- "last_run_at": "2026-02-23T17:57:38.418+11:00",
- "highest_error_count": 2,
- "description": "Verifies if a change can be started based on its owner configuration and, if so, starts it."
}, - {
- "job_class": "DataCleanupJob",
- "total": 5,
- "running": 0,
- "failed": 0,
- "scheduled": 0,
- "finished": 0,
- "pending": 0,
- "next_run_at": "2026-02-23T19:57:38.418+11:00",
- "last_run_at": "2026-02-23T16:57:38.418+11:00",
- "highest_error_count": 0,
- "description": "Cleans up data based on a data cleanup definition."
}
]
}
}
]
}Returns the status of all the OpsChain API workers in the configured namespace.
{- "data": [
- {
- "id": "opschain-api-worker-1",
- "type": "worker",
- "attributes": {
- "namespace": "opschain",
- "node": "node-1",
- "host_ip": "192.168.1.1",
- "pod_ip": "192.168.1.2",
- "start_time": "2021-01-01T00:00:00Z",
- "state": "Running",
- "image": "opschain-api-worker-image",
- "restart_count": 0
}
}
]
}Lists all data cleanup definitions.
| filter[<query/sort filter>]= |
{- "data": [
- {
- "id": "38aabbf5-f55f-4ed9-987f-e1b1dac7c208",
- "type": "data_cleanup_definition",
- "attributes": {
- "name": "panel",
- "enabled": true,
- "created_by": "laurice",
- "cron_schedule": "0 0 7,14,21,28 * *",
- "repeat": true,
- "maximum_run_count": null,
- "purge_activities": true,
- "purge_events": false,
- "purge_jobs": true,
- "purge_agent_images": false,
- "filters": {
- "changes": {
- "created_at_lt": "2026-02-16T07:57:56.089Z"
}
}, - "node_paths": [
- "/projects/opc/environments/dev"
], - "run_count": 0,
- "created_at": "2026-02-23T07:57:56.096104Z",
- "updated_at": "2026-02-23T07:57:56.096104Z",
- "next_run_at": "2026-02-27T13:00:00.000000Z",
- "run_at": null,
- "end_at": null
}, - "links": {
- "self": "/api/data_cleanup_definitions/38aabbf5-f55f-4ed9-987f-e1b1dac7c208"
}
}
], - "meta": {
- "authorisations": {
- "update": true
}, - "has_any": true
}
}Notes:
cron_schedule or run_at fields must be provided.filters field are changes, events, jobs, and workflow_runs. Each of these can have ransack filters for the specific type they refer to.
IMPORTANT: If no filters are provided for a data type, the cleanup will remove all data that matches the node paths.node_paths field is an array of strings. Each string is a path to a node. The path must start with /projects and only contain forward slashes, lowercase letters, numbers and underscores, and optionally a single "%" at the end.
Use the % wildcard to include all nodes under a specific node or node-type, note that this will apply the cleanup to all nodes that are yet to be created, as long as they match the path.required | object |
{- "data": {
- "attributes": {
- "name": "Will run once at 1am on 1st January 2020",
- "enabled": true,
- "node_paths": [ ],
- "filters": { },
- "purge_activities": false,
- "purge_events": false,
- "purge_jobs": false,
- "cron_schedule": "36 0 4 2 4",
- "run_at": "2020-01-01 01:00:00 UTC",
- "end_at": null,
- "maximum_run_count": null,
- "repeat": false,
- "purge_agent_images": false
}
}
}{- "data": {
- "id": "8eb0404b-c9c0-483e-81bf-98cba8685fba",
- "type": "data_cleanup_definition",
- "attributes": {
- "name": "transmitter",
- "enabled": true,
- "created_by": "francis_wilkinson",
- "cron_schedule": "6 7 13 5 2",
- "repeat": true,
- "maximum_run_count": null,
- "purge_activities": false,
- "purge_events": true,
- "purge_jobs": true,
- "purge_agent_images": false,
- "filters": { },
- "node_paths": [ ],
- "run_count": 0,
- "created_at": "2026-02-23T07:57:56.293944Z",
- "updated_at": "2026-02-23T07:57:56.293944Z",
- "next_run_at": "2026-05-04T21:06:00.000000Z",
- "run_at": null,
- "end_at": null
}, - "links": {
- "self": "/api/data_cleanup_definitions/8eb0404b-c9c0-483e-81bf-98cba8685fba"
}
}, - "meta": {
- "authorisations": {
- "update": true
}
}
}Shows a data cleanup definition.
| data_cleanup_definition_id required | string Example: 0c05977d-d393-42ee-aa30-9f221e0ec3af data cleanup definition id |
{- "data": {
- "id": "b3219929-8d1f-4d02-a330-5a86b145f28a",
- "type": "data_cleanup_definition",
- "attributes": {
- "name": "bandwidth",
- "enabled": true,
- "created_by": "kristeen",
- "cron_schedule": "0 0 7,14,21,28 * *",
- "repeat": true,
- "maximum_run_count": null,
- "purge_activities": false,
- "purge_events": false,
- "purge_jobs": true,
- "purge_agent_images": true,
- "filters": {
- "changes": {
- "created_at_lt": "2026-02-16T07:57:56.587Z"
}
}, - "node_paths": [
- "/projects/opc/environments/dev"
], - "run_count": 0,
- "created_at": "2026-02-23T07:57:56.592122Z",
- "updated_at": "2026-02-23T07:57:56.592122Z",
- "next_run_at": "2026-02-27T13:00:00.000000Z",
- "run_at": null,
- "end_at": null
}, - "links": {
- "self": "/api/data_cleanup_definitions/b3219929-8d1f-4d02-a330-5a86b145f28a"
}
}, - "meta": {
- "authorisations": {
- "update": true
}
}
}Updates a data cleanup definition.
Notes:
| data_cleanup_definition_id required | string Example: 0c05977d-d393-42ee-aa30-9f221e0ec3af data cleanup definition id |
required | object |
{- "data": {
- "attributes": {
- "name": "new_name",
- "enabled": true,
- "node_paths": [ ],
- "filters": { },
- "purge_activities": true,
- "purge_events": false,
- "purge_jobs": false,
- "cron_schedule": "56 22 25 8 6",
- "run_at": null,
- "end_at": null,
- "maximum_run_count": null,
- "repeat": true,
- "purge_agent_images": true
}
}
}{- "data": {
- "id": "5457a106-b11f-4de1-bdca-3ed245fed8ae",
- "type": "data_cleanup_definition",
- "attributes": {
- "name": "new_name",
- "enabled": true,
- "created_by": "marth.mueller",
- "cron_schedule": "0 0 7,14,21,28 * *",
- "repeat": true,
- "maximum_run_count": 5,
- "purge_activities": true,
- "purge_events": true,
- "purge_jobs": true,
- "purge_agent_images": false,
- "filters": {
- "changes": {
- "created_at_lt": "2026-02-16T07:57:56.908Z"
}
}, - "node_paths": [
- "/projects/opc/environments/dev"
], - "run_count": 0,
- "created_at": "2026-02-23T07:57:56.911702Z",
- "updated_at": "2026-02-23T07:57:56.942505Z",
- "next_run_at": "2026-02-27T13:00:00.000000Z",
- "run_at": null,
- "end_at": null
}, - "links": {
- "self": "/api/data_cleanup_definitions/5457a106-b11f-4de1-bdca-3ed245fed8ae"
}
}, - "meta": {
- "authorisations": {
- "update": true
}
}
}Delete a data cleanup definition.
| data_cleanup_definition_id required | string Example: 0c05977d-d393-42ee-aa30-9f221e0ec3af data cleanup definition id |
{- "errors": [
- {
- "status": 404,
- "title": "Record not found",
- "meta": {
- "message": "Couldn't find DataCleanupDefinition"
}
}
]
}